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 2003-2004 (C) Intalio, Inc. All Rights Reserved.
42   *
43   * $Id$
44   */
45  package org.exolab.castor.xml.descriptors;
46  
47  import org.exolab.castor.mapping.FieldHandler;
48  import org.exolab.castor.xml.NodeType;
49  import org.exolab.castor.xml.XMLFieldHandler;
50  import org.exolab.castor.xml.util.XMLClassDescriptorImpl;
51  import org.exolab.castor.xml.util.XMLFieldDescriptorImpl;
52  
53  /**
54   * The default class descriptor for Enumerations that are passed in as the
55   * root-level class, this is really only useful for marshaling, as Enumerations
56   * are immutable.
57   *
58   * @author <a href="mailto:kvisco-at-intalio.com">Keith Visco</a>
59   * @version $Revision$ $Date: 2004-12-16 22:49:25 -0700 (Thu, 16 Dec 2004) $
60   */
61  public class EnumerationDescriptor extends XMLClassDescriptorImpl {
62  
63        //----------------/
64       //- Constructors -/
65      //----------------/
66  
67      /**
68       * Creates a new EnumerationDescriptor.
69       */
70      public EnumerationDescriptor() {
71          super(java.util.Enumeration.class);
72          //-- create element descriptor
73  
74          XMLFieldDescriptorImpl desc = new XMLFieldDescriptorImpl(Object.class,
75                  "_elements", null, NodeType.Element);
76  
77          FieldHandler handler = (new XMLFieldHandler() {
78  
79              /**
80               * {@inheritDoc}
81               */
82              public Object getValue(final Object object) throws IllegalStateException {
83                  return object;
84              }
85  
86              /**
87               * {@inheritDoc}
88               */
89              public void setValue(final Object object, final Object value)
90                  throws IllegalStateException, IllegalArgumentException {
91                  //-- do nothing since enumerations are immutable.
92              }
93  
94              /**
95               * {@inheritDoc}
96               */
97              public Object newInstance(final Object parent) {
98                  //-- not used
99                  return null;
100             }
101         });
102         desc.setHandler(handler);
103         desc.setMultivalued(true);
104 
105         addFieldDescriptor(desc);
106     } //-- EnumerationDescriptor()
107 
108 } //-- EnumerationDescriptor