View Javadoc
1   /*
2    * Redistribution and use of this software and associated documentation ("Software"), with or
3    * without modification, are permitted provided that the following conditions are met:
4    *
5    * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6    * must also contain a copy of this document.
7    *
8    * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9    * conditions and the following disclaimer in the documentation and/or other materials provided with
10   * the distribution.
11   *
12   * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13   * without prior written permission of Intalio, Inc. For written permission, please contact
14   * info@exolab.org.
15   *
16   * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17   * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18   * Intalio, Inc.
19   *
20   * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21   *
22   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   *
31   * Copyright 2003-2004 (C) Intalio, Inc. All Rights Reserved.
32   *
33   * $Id$
34   */
35  package org.exolab.castor.xml.descriptors;
36  
37  import org.exolab.castor.mapping.FieldHandler;
38  import org.exolab.castor.xml.NodeType;
39  import org.exolab.castor.xml.XMLFieldHandler;
40  import org.exolab.castor.xml.util.XMLClassDescriptorImpl;
41  import org.exolab.castor.xml.util.XMLFieldDescriptorImpl;
42  
43  /**
44   * The default class descriptor for Enumerations that are passed in as the root-level class, this is
45   * really only useful for marshaling, as Enumerations are immutable.
46   *
47   * @author <a href="mailto:kvisco-at-intalio.com">Keith Visco</a>
48   * @version $Revision$ $Date: 2004-12-16 22:49:25 -0700 (Thu, 16 Dec 2004) $
49   */
50  public class EnumerationDescriptor extends XMLClassDescriptorImpl {
51  
52    // ----------------/
53    // - Constructors -/
54    // ----------------/
55  
56    /**
57     * Creates a new EnumerationDescriptor.
58     */
59    public EnumerationDescriptor() {
60      super(java.util.Enumeration.class);
61      // -- create element descriptor
62  
63      XMLFieldDescriptorImpl desc =
64          new XMLFieldDescriptorImpl(Object.class, "_elements", null, NodeType.Element);
65  
66      FieldHandler handler = (new XMLFieldHandler() {
67  
68        /**
69         * {@inheritDoc}
70         */
71        public Object getValue(final Object object) throws IllegalStateException {
72          return object;
73        }
74  
75        /**
76         * {@inheritDoc}
77         */
78        public void setValue(final Object object, final Object value)
79            throws IllegalStateException, IllegalArgumentException {
80          // -- do nothing since enumerations are immutable.
81        }
82  
83        /**
84         * {@inheritDoc}
85         */
86        public Object newInstance(final Object parent) {
87          // -- not used
88          return null;
89        }
90      });
91      desc.setHandler(handler);
92      desc.setMultivalued(true);
93  
94      addFieldDescriptor(desc);
95    } // -- EnumerationDescriptor()
96  
97  } // -- EnumerationDescriptor