View Javadoc
1   /*
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Intalio, Inc.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Intalio, Inc. Exolab is a registered
23   *    trademark of Intalio, Inc.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2004 (C) Intalio, Inc. All Rights Reserved.
42   *
43   * $Id$
44   */
45  package org.exolab.castor.xml.handlers;
46  
47  import org.exolab.castor.mapping.FieldHandler;
48  import org.exolab.castor.mapping.GeneralizedFieldHandler;
49  
50  /**
51   * An implementation of GeneralizedFieldHandler that simply calls
52   * Object#toString() in the conversion methods.
53   *
54   * @author <a href="kvisco@intalio.com">Keith Visco</a>
55   * @version $Revision$ $Date: 2005-02-28 17:53:23 -0700 (Mon, 28 Feb 2005) $
56   */
57  public class ToStringFieldHandler extends GeneralizedFieldHandler {
58  
59      /** The class type for this FieldHandler. */
60      private final Class _type;
61  
62      /**
63       * Creates a new ToStringFieldHandler.
64       *
65       * @param type the class type to create the FieldHandler for
66       */
67      public ToStringFieldHandler(final Class type) {
68          this(type, null);
69      } //-- ToStringFieldHandler
70  
71      /**
72       * Creates a new ToStringFieldHandler.
73       *
74       * @param type the class type to create the FieldHandler for
75       * @param handler the FieldHandler to wrap
76       */
77      public ToStringFieldHandler(final Class type, final FieldHandler handler) {
78          super();
79          if (type == null) {
80              throw new IllegalArgumentException("The argument 'type' must not be null.");
81          }
82          _type = type;
83          if (handler != null) {
84              setFieldHandler(handler);
85          }
86      } //-- ToStringFieldHandler
87  
88      /**
89       * {@inheritDoc}
90       * @see org.exolab.castor.mapping.GeneralizedFieldHandler#convertUponGet(java.lang.Object)
91       */
92      public Object convertUponGet(final Object value) {
93          if (value == null) {
94              return null;
95          }
96          return value.toString();
97      } //-- convertUponGet
98  
99      /**
100      * {@inheritDoc}
101      * @see org.exolab.castor.mapping.GeneralizedFieldHandler#convertUponSet(java.lang.Object)
102      */
103     public Object convertUponSet(final Object value) {
104         if (value == null) {
105             return null;
106         }
107         return value.toString();
108     } //-- convertUponSet;
109 
110     /**
111      * {@inheritDoc}
112      * @see org.exolab.castor.mapping.GeneralizedFieldHandler#getFieldType()
113      */
114     public Class getFieldType() {
115         return _type;
116     } //-- getFieldType
117 
118 } //-- ValueOfFieldHandler