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