spoon.support.util

Interface ImmutableMap

All Known Implementing Classes:

ImmutableMapImpl

public interface ImmutableMap

An immutable map. (eg unmodifiable storage of parameter name-value pairs). The values may be primitive values or List, Set, Map of values. All internal containers are unmodifiable too. Internal class only, not in the public API.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	asMap()
ImmutableMap	checkpoint()
java.util.Map<java.lang.String,java.lang.Object>	getModifiedValues()
java.lang.Object	getValue(java.lang.String parameterName)
boolean	hasValue(java.lang.String parameterName)
ImmutableMap	putValue(java.lang.String parameterName, java.lang.Object value)

Method Detail

hasValue

boolean hasValue(java.lang.String parameterName)

Parameters:

parameterName - to be checked parameter name

Returns:

true if there is defined some value for the parameter. null can be a value too

getValue

java.lang.Object getValue(java.lang.String parameterName)

Parameters:

parameterName - the name of the parameter

Returns:

a value of the parameter under the name `parameterNamer

putValue

ImmutableMap putValue(java.lang.String parameterName,
                      java.lang.Object value)

Parameters:

parameterName - to be set parameter name

value - the new value

Returns:

copies this ImmutableMap, sets the new value there and returns that copy

asMap

java.util.Map<java.lang.String,java.lang.Object> asMap()

Returns:

underlying unmodifiable Map<String, Object>

checkpoint

ImmutableMap checkpoint()

Returns:

a new instance of ImmutableMap, which inherits all values from this ImmutableMap Any call of putValue(String, Object) is remembered in local Map of parameters. At the end of process the getModifiedValues() can be used to return all the parameters which were changed after local ImmutableMap was created

getModifiedValues

java.util.Map<java.lang.String,java.lang.Object> getModifiedValues()

Returns:

the modified parameters since last call to checkpoint()