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 2002 (C) Intalio, Inc. All Rights Reserved.
32   *
33   * $Id$
34   */
35  package org.exolab.castor.xml.util;
36  
37  /**
38   * A light-weight object used to wrap any object. This allows Castor to effectively "wrap" and
39   * "unwrap" elements during marshaling and unmarshaling.
40   *
41   * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
42   */
43  public class ContainerElement {
44  
45    /** The "parent" object, i.e., the object that the contained object actually belongs to. */
46    private Object _parent = null;
47    /** The object "contained" within this ContainerElement. */
48    private Object _object = null;
49  
50    /**
51     * Creates a new empty ContainerElement.
52     */
53    public ContainerElement() {
54      super();
55    } // -- ContainerElement
56  
57    /**
58     * Creates a ContainerElement with the specified object.
59     *
60     * @param object the Object to set
61     */
62    public ContainerElement(Object object) {
63      super();
64      _object = object;
65    } // -- ContainerElement
66  
67    /**
68     * Returns the object contained within this ContainerElement.
69     *
70     * @return the object contained within this ContainerElement.
71     */
72    public Object getObject() {
73      return _object;
74    } // -- getObject
75  
76    /**
77     * Returns the parent of the contained object.
78     *
79     * @return the parent of the contained object.
80     */
81    public Object getParent() {
82      return _parent;
83    } // -- getParent
84  
85    /**
86     * Sets the object that is contained within this ContainerElement.
87     *
88     * @param object the Object to set
89     */
90    public void setObject(Object object) {
91      _object = object;
92    } // -- setObject
93  
94    /**
95     * Sets the parent of the contained object.
96     *
97     * @param parent the parent of the contained object
98     */
99    public void setParent(Object parent) {
100     _parent = parent;
101   } // -- setParent
102 
103 } // -- class: ContainerElement