View Javadoc

1   /*
2    * Copyright (c) 2001 - 2005 ivata limited.
3    * All rights reserved.
4    * -----------------------------------------------------------------------------
5    * ivata masks may be redistributed under the GNU General Public
6    * License as published by the Free Software Foundation;
7    * version 2 of the License.
8    *
9    * These programs are free software; you can redistribute them and/or
10   * modify them under the terms of the GNU General Public License
11   * as published by the Free Software Foundation; version 2 of the License.
12   *
13   * These programs are distributed in the hope that they will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16   *
17   * See the GNU General Public License in the file LICENSE.txt for more
18   * details.
19   *
20   * If you would like a copy of the GNU General Public License write to
21   *
22   * Free Software Foundation, Inc.
23   * 59 Temple Place - Suite 330
24   * Boston, MA 02111-1307, USA.
25   *
26   *
27   * To arrange commercial support and licensing, contact ivata at
28   *                  http://www.ivata.com/contact.jsp
29   * -----------------------------------------------------------------------------
30   * $Log: ClassFieldValueConvertor.java,v $
31   * Revision 1.4  2005/04/11 12:27:01  colinmacleod
32   * Added preliminary support for filters.
33   * Added FieldValueConvertor factor interface
34   * to split off value convertors for reuse.
35   *
36   * Revision 1.3  2005/04/09 18:04:14  colinmacleod
37   * Changed copyright text to GPL v2 explicitly.
38   *
39   * Revision 1.2  2005/01/06 22:13:21  colinmacleod
40   * Moved up a version number.
41   * Changed copyright notices to 2005.
42   * Updated the documentation:
43   *   - started working on multiproject:site docu.
44   *   - changed the logo.
45   * Added checkstyle and fixed LOADS of style issues.
46   * Added separate thirdparty subproject.
47   * Added struts (in web), util and webgui (in webtheme) from ivata op.
48   *
49   * Revision 1.1  2004/12/29 20:07:07  colinmacleod
50   * Renamed subproject masks to mask.
51   *
52   * Revision 1.1.1.1  2004/05/16 20:40:32  colinmacleod
53   * Ready for 0.1 release
54   * -----------------------------------------------------------------------------
55   */
56  package com.ivata.mask.field;
57  /***
58   * <p>
59   * Convert an object representing a class.
60   * </p>
61   *
62   * @since ivata masks 0.1 (2004-05-14)
63   * @author Colin MacLeod
64   * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
65   * @version $Revision: 1.4 $
66   */
67  public class ClassFieldValueConvertor extends FieldValueConvertor {
68      /***
69       * <p>
70       * Convert an object representing a class to a string. This returns the full
71       * class name
72       * </p>
73       *
74       * @param objectValue
75       *            object to be converted.
76       * @return string equivalent of the object provided.
77       * @see com.ivata.mask.web.field.FieldValueConvertor#toString
78       */
79      protected String toString(final Object objectValue) {
80          return ((Class) objectValue).getName();
81      }
82      /***
83       * <p>
84       * Convert a class value from a string representing its name.
85       * </p>
86       *
87       * @param propertyClass
88       *            exact class to be converted to.
89       * @param stringValue
90       *            value to be converted.
91       * @return valid class converted from a string.
92       * @see com.ivata.mask.field.FieldValueConvertor#convertFromString
93       */
94      public Object convertFromString(final Class propertyClass,
95              final String stringValue) {
96          try {
97              return Class.forName(stringValue);
98          } catch (ClassNotFoundException e) {
99              throw new FieldValueException(e);
100         }
101     }
102 }