001: /**
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
042: */package org.exolab.javasource;
043:
044: import java.util.Vector;
045:
046: /**
047: * A simple String to Object mapping which preserves order.
048: * <br/>
049: * <B>Note:</B> This class is not synchronized. So be careful. :-)
050: *
051: * @author <a href="mailto:keith AT kvisco DOT com">Keith Visco</a>
052: * @version $Revision: 6669 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
053: */
054: public final class JNamedMap {
055: //--------------------------------------------------------------------------
056:
057: /** Names as mapped to objects. */
058: private Vector _names;
059:
060: /** Objects that the names are mapped to. */
061: private Vector _objects;
062:
063: //--------------------------------------------------------------------------
064:
065: /**
066: * Creates a new JNamedMap.
067: */
068: public JNamedMap() {
069: _names = new Vector();
070: _objects = new Vector();
071: }
072:
073: /**
074: * Creates a new JNamedMap with the given size.
075: *
076: * @param size The initial size for this NamedMap.
077: */
078: public JNamedMap(final int size) {
079: _names = new Vector(size);
080: _objects = new Vector(size);
081: }
082:
083: //--------------------------------------------------------------------------
084:
085: /**
086: * Returns the Object associated with the given name.
087: *
088: * @param name The name to search for.
089: * @return The Object associated with the given name.
090: */
091: public Object get(final String name) {
092: int i = indexOf(name);
093: if (i >= 0) {
094: return _objects.elementAt(i);
095: }
096: return null;
097: }
098:
099: /**
100: * Returns the Object at the given index.
101: *
102: * @param index The index of the Object to return.
103: * @return The Object at the given index.
104: */
105: public Object get(final int index) {
106: return _objects.elementAt(index);
107: }
108:
109: /**
110: * Returns the name associated with the given Object.
111: *
112: * @param obj The Object to search for.
113: * @return The name of the given Object.
114: */
115: public String getNameByObject(final Object obj) {
116: int i = _objects.indexOf(obj);
117: if (i >= 0) {
118: return (String) _names.elementAt(i);
119: }
120: return null;
121: }
122:
123: /**
124: * Returns a Vector of names.
125: *
126: * @return A Vector of names.
127: */
128: public Vector getNames() {
129: return (Vector) _names.clone();
130: }
131:
132: /**
133: * Returns a Vector of Objects.
134: *
135: * @return A Vector of Objects.
136: */
137: public Vector getObjects() {
138: return (Vector) _objects.clone();
139: }
140:
141: /**
142: * Returns the index of the Object which has been mapped (associated) with
143: * the given name.
144: *
145: * @param name The name to get the index of.
146: * @return The index of the Object which has been mapped (associated) to the
147: * given name.
148: */
149: public int indexOf(final String name) {
150: for (int i = 0; i < _names.size(); i++) {
151: String iName = (String) _names.elementAt(i);
152: if (iName.equals(name)) {
153: return i;
154: }
155: }
156: return -1;
157: }
158:
159: /**
160: * Maps (associates) an Object with a name.
161: *
162: * @param name The name to associate with the given Object.
163: * @param obj The Object to be mapped.
164: */
165: public void put(final String name, final Object obj) {
166: int idx = indexOf(name);
167:
168: if (idx >= 0) {
169: _objects.setElementAt(obj, idx);
170: } else {
171: //-- we may need synchronization here if we're in a multithreaded environment
172: _names.addElement(name);
173: _objects.addElement(obj);
174: }
175: }
176:
177: /**
178: * Removes and returns the Object located at the given index.
179: *
180: * @param index The index of the Object to remove.
181: * @return The object removed from the map.
182: */
183: public Object remove(final int index) {
184: Object obj = _objects.elementAt(index);
185: _objects.removeElementAt(index);
186: _names.removeElementAt(index);
187: return obj;
188: }
189:
190: /**
191: * Removes and returns the Object associated with the given name.
192: *
193: * @param name The name of the Object to remove.
194: * @return The object removed from the map.
195: */
196: public Object remove(final String name) {
197: Object obj = null;
198:
199: int idx = indexOf(name);
200: if (idx >= 0) {
201: obj = _objects.elementAt(idx);
202: _objects.removeElementAt(idx);
203: _names.removeElementAt(idx);
204: }
205: return obj;
206: }
207:
208: /**
209: * Returns the number of Object associations currently in this named map.
210: *
211: * @return The number of Object associations currently in this named map.
212: */
213: public int size() {
214: return _names.size();
215: }
216:
217: //--------------------------------------------------------------------------
218: }
|