Package org.codehaus.modello.plugin.java.javasource

Class JNamedMap

java.lang.Object

org.codehaus.modello.plugin.java.javasource.JNamedMap

public class JNamedMap
extends java.lang.Object

A simple String to Object mapping which preserves order.

Note: This class is not synchronized. So be careful. :-)

Author:

Keith Visco

Constructor Summary

Constructors

Constructor	Description
JNamedMap()	Creates a new JNamedMap
JNamedMap(int size)	Creates a new JNamedMap with the given size.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	get(int index)	Returns the Object at the given index.
java.lang.Object	get(java.lang.String name)	Returns the Object associated with the given name.
java.lang.String	getNameByObject(java.lang.Object obj)	Returns the name associated with the given Object
java.util.Vector<java.lang.String>	getNames()	Return a Vector of names
java.util.Vector<java.lang.Object>	getObjects()	Return a Vector of Objects
int	indexOf(java.lang.String name)	Returns the index of the Object which has been mapped (associated) with the given name
void	put(java.lang.String name, java.lang.Object obj)	Maps (associates) an Object with a name
java.lang.Object	remove(int index)	Removes and returns the Object located at the given index
java.lang.Object	remove(java.lang.String name)	Removes and returns the Object associated with the given name
int	size()	Returns the number of Object associations currently in this named map

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JNamedMap

public JNamedMap()

Creates a new JNamedMap

JNamedMap

public JNamedMap(int size)

Creates a new JNamedMap with the given size.

Parameters:

size - the initial size for this NamedMap

Method Detail

get

public java.lang.Object get(java.lang.String name)

Returns the Object associated with the given name.

Parameters:

name - the name to search for

Returns:

the Object associated with the given name

get

public java.lang.Object get(int index)
                     throws java.lang.IndexOutOfBoundsException

Returns the Object at the given index.

Parameters:

index - the index of the Object to return

Returns:

the Object at the given index

Throws:

java.lang.IndexOutOfBoundsException

getNameByObject

public java.lang.String getNameByObject(java.lang.Object obj)

Returns the name associated with the given Object

Parameters:

obj - the Object to search for

Returns:

the name of the given Object

getNames

public java.util.Vector<java.lang.String> getNames()

Return a Vector of names

Returns:

a Vector of names

getObjects

public java.util.Vector<java.lang.Object> getObjects()

Return a Vector of Objects

Returns:

a Vector of Objects

indexOf

public int indexOf(java.lang.String name)

Returns the index of the Object which has been mapped (associated) with the given name

Parameters:

name - the name

Returns:

the index of the Object which has been mapped (associated) to the given name

put

public void put(java.lang.String name,
                java.lang.Object obj)

Maps (associates) an Object with a name

Parameters:

name - the name to associate with the given Object

obj - the Object to be mapped

remove

public java.lang.Object remove(int index)
                        throws java.lang.IndexOutOfBoundsException

Removes and returns the Object located at the given index

Parameters:

index - the index of the Object to remove

Returns:

the object removed from the map.

Throws:

java.lang.IndexOutOfBoundsException

remove

public java.lang.Object remove(java.lang.String name)

Removes and returns the Object associated with the given name

Parameters:

name - the name of the Object to remove

Returns:

the object removed from the map.

size

public int size()

Returns the number of Object associations currently in this named map

Returns:

the number of Object associations currently in this named map