com.pega.pegarules.pub.util
Interface StringMap

All Superinterfaces:

java.util.Map

All Known Subinterfaces:

ClipboardPage

All Known Implementing Classes:

HashStringMap, ParameterPage

public interface StringMap
extends java.util.Map

The StringMap interface specializes the Map interface with the expectation that both the key and value will be String instances. This supports our 'typical' usage -- to supply String values identified by name -- while remaining consistent with the more general Java-defined interface.

It is expected that most implementations will limit what names may be used and, possibly, what values may be associated with them.

Version:

$Revision: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

John van der Meer

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

java.lang.String	getString(java.lang.String aName) Identifies the value, if any, that is associated with the specified name.
void	putString(java.lang.String aName, java.lang.String aValue) Establishes an association between the specified value and the specified name (optional operation).
java.lang.String	toString() Returns a string representation of the key/value pairs in this StringMap object.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

Method Detail

getString

java.lang.String getString(java.lang.String aName)

Identifies the value, if any, that is associated with the specified name.

Parameters:

aName - name whose associated value is to be returned

Returns:

the String value associated with the specified name, or null if this instance includes no association for this name

putString

void putString(java.lang.String aName,
               java.lang.String aValue)

Establishes an association between the specified value and the specified name (optional operation). Any previous association for this name is replaced.

Parameters:

aName - name with which the specified value is to be associated

aValue - value to be associated with the specified name

Throws:

java.lang.IllegalArgumentException - if some aspect of this name or value prevents it from being stored in this instance

java.lang.NullPointerException - if either the name or the value is null and is not allowed to be by the implementation

java.lang.UnsupportedOperationException - if putString is not supported by this implementation

toString

java.lang.String toString()

Returns a string representation of the key/value pairs in this StringMap object.

Overrides:

toString in class java.lang.Object

Returns:

String The string representation of this map.