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  
36  package org.exolab.castor.mapping;
37  
38  /**
39   * Represents a Mapped Object. This Class allows for more control over the key used in Maps and
40   * Hashtables.
41   * 
42   * @author <a href="kvisco@intalio.com">Keith Visco</a>
43   * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
44   */
45  public class MapItem<K, V> {
46  
47    /**
48     * The key
49     */
50    private K _key = null;
51  
52    /**
53     * The value
54     */
55    private V _value = null;
56  
57    /**
58     * Creates a new empty MapItem.
59     */
60    public MapItem() {
61      super();
62    }
63  
64    /**
65     * Creates a new MapItem with the given key and value.
66     * 
67     * @param key the key Object for this MapItem.
68     * @param value the value for this MapItem.
69     */
70    public MapItem(K key, V value) {
71      _key = key;
72      _value = value;
73    }
74  
75    /**
76     * Returns the key Object for this MapItem, or null if no key has been specified.
77     * 
78     * @return the key Object for this MapItem.
79     */
80    public K getKey() {
81      return _key;
82    }
83  
84    /**
85     * Returns the value Object for this MapItem, or null if no value has yet been specified.
86     * 
87     * @return the value Object for this MapItem.
88     */
89    public V getValue() {
90      return _value;
91    }
92  
93    /**
94     * Sets the key for this MapItem.
95     * 
96     * @param key the key Object for this MapItem.
97     */
98    public void setKey(K key) {
99      _key = key;
100   } // -- setKey
101 
102   /**
103    * Sets the value for this MapItem.
104    * 
105    * @param value the value Object for this MapItem.
106    */
107   public void setValue(V value) {
108     _value = value;
109   } // -- setValue
110 
111 } // -- MapItem
112