org.mortbay.util

Class StringMap

public class StringMap extends AbstractMap implements Externalizable

Map like class of Strings to Objects. This String Map has been optimized for mapping small sets of Strings where the most frequently accessed Strings have been put to the map first. It also has the benefit that it can look up entries by substring or sections of char and byte arrays. This can prevent many String objects from being created just to look up in the map. This map is NOT synchronized.

Version: $Id: StringMap.java,v 1.13 2004/10/23 09:03:22 gregwilkins Exp $

Author: Greg Wilkins (gregw)

Field Summary
protected HashSet	_entrySet
protected boolean	_ignoreCase
protected StringMap.NullEntry	_nullEntry
protected Object	_nullValue
protected StringMap.Node	_root
protected Set	_umEntrySet
protected int	_width

Constructor Summary
	StringMap() Constructor.
	StringMap(boolean ignoreCase) Constructor.
	StringMap(boolean ignoreCase, int width) Constructor.

Method Summary
void	clear()
boolean	containsKey(Object key)
Set	entrySet()
Object	get(Object key)
Object	get(String key)
Entry	getEntry(String key, int offset, int length) Get a map entry by substring key.
Entry	getEntry(char[] key, int offset, int length) Get a map entry by char array key.
Entry	getEntry(byte[] key, int offset, int length) Get a map entry by byte array key.
int	getWidth()
boolean	isEmpty()
boolean	isIgnoreCase()
Object	put(Object key, Object value)
Object	put(String key, Object value)
void	readExternal(ObjectInput in)
Object	remove(Object key)
Object	remove(String key)
void	setIgnoreCase(boolean ic) Set the ignoreCase attribute.
void	setWidth(int width) Set the hash width.
int	size()
void	writeExternal(ObjectOutput out)

Field Detail

_entrySet

protected HashSet _entrySet

_ignoreCase

protected boolean _ignoreCase

_nullEntry

protected StringMap.NullEntry _nullEntry

_nullValue

protected Object _nullValue

_root

protected StringMap.Node _root

_umEntrySet

protected Set _umEntrySet

_width

protected int _width

Constructor Detail

StringMap

public StringMap()

Constructor.

StringMap

public StringMap(boolean ignoreCase)

Constructor.

Parameters: ignoreCase

StringMap

public StringMap(boolean ignoreCase, int width)

Constructor.

Parameters: ignoreCase width Width of hash tables, larger values are faster but use more memory.

Method Detail

clear

public void clear()

containsKey

public boolean containsKey(Object key)

entrySet

public Set entrySet()

get

public Object get(Object key)

get

public Object get(String key)

getEntry

public Entry getEntry(String key, int offset, int length)

Get a map entry by substring key.

Parameters: key String containing the key offset Offset of the key within the String. length The length of the key

Returns: The Map.Entry for the key or null if the key is not in the map.

getEntry

public Entry getEntry(char[] key, int offset, int length)

Get a map entry by char array key.

Parameters: key char array containing the key offset Offset of the key within the array. length The length of the key

Returns: The Map.Entry for the key or null if the key is not in the map.

getEntry

public Entry getEntry(byte[] key, int offset, int length)

Get a map entry by byte array key.

Parameters: key byte array containing the key. A simple ASCII byte to char mapping is used. offset Offset of the key within the array. length The length of the key

Returns: The Map.Entry for the key or null if the key is not in the map.

Parameters: ic If true, the map is case insensitive for keys.

setWidth

public void setWidth(int width)

Set the hash width.

Parameters: width Width of hash tables, larger values are faster but use more memory.

size

public int size()

writeExternal

public void writeExternal(ObjectOutput out)