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