Package com.tangosol.coherence.config

Class ResolvableParameterList

java.lang.Object

com.tangosol.coherence.config.ResolvableParameterList

All Implemented Interfaces:

ParameterList, ParameterResolver, ExternalizableLite, PortableObject, Serializable, Iterable<Parameter>

public class ResolvableParameterList
extends Object
implements ParameterList, ParameterResolver, ExternalizableLite, PortableObject

A ResolvableParameterList is a ParameterList implementation that additionally supports name-based Parameter resolution as defined by the ParameterResolver interface.

Since:

Coherence 12.1.2

Author:

bo 2011.06.22

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResolvableParameterList()	Constructs an empty ResolvableParameterList.
ResolvableParameterList(ParameterList listParameters)	Constructs a ResolvableParameterList based on a ParameterList.
ResolvableParameterList(Map map)	Construct a ResolvableParameterList from provided map.

Method Summary

Modifier and Type	Method	Description
void	add(Parameter parameter)	Adds a Parameter to the end of the ParameterList or replaces an existing Parameter in the ParameterList.
boolean	isEmpty()	Determines if there are any Parameters in the ParameterList.
Iterator<Parameter>	iterator()
void	readExternal(PofReader reader)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
Parameter	resolve(String sName)	Obtains the specified named Parameter.
int	size()	Obtains the number of Parameters in the ParameterList.
String	toString()
void	writeExternal(PofWriter writer)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ResolvableParameterList

public ResolvableParameterList()

Constructs an empty ResolvableParameterList.

ResolvableParameterList

public ResolvableParameterList(ParameterList listParameters)

Constructs a ResolvableParameterList based on a ParameterList.

Parameters:

listParameters - the ParameterList from which Parameters should be drawn

ResolvableParameterList

public ResolvableParameterList(Map map)

Construct a ResolvableParameterList from provided map. The key of the map is used as the parameter name and the corresponding value as the parameter value.

Parameters:

map - the Map of Named Parameter of type String to an Object value

Since:

Coherence 12.2.1

Method Detail

resolve

public Parameter resolve(String sName)

Obtains the specified named Parameter.

Specified by:

resolve in interface ParameterResolver

Parameters:

sName - the name of the Parameter

Returns:

the Parameter or null if the Parameter can't be resolved

add

public void add(Parameter parameter)

Adds a Parameter to the end of the ParameterList or replaces an existing Parameter in the ParameterList.

Should a Parameter with the same name as the specified Parameter already exist in the list, the specified Parameter will replace the existing Parameter in the list.

Specified by:

add in interface ParameterList

Parameters:

parameter - the Parameter to add or replace

isEmpty

public boolean isEmpty()

Determines if there are any Parameters in the ParameterList.

Specified by:

isEmpty in interface ParameterList

Returns:

true if there are Parameters, false otherwise

size

public int size()

Obtains the number of Parameters in the ParameterList.

Specified by:

size in interface ParameterList

Returns:

the number of Parameters

iterator

public Iterator<Parameter> iterator()

Specified by:

iterator in interface Iterable<Parameter>

readExternal

public void readExternal(DataInput in)
                  throws IOException

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader reader)
                  throws IOException

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

reader - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter writer)
                   throws IOException

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

writer - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs

toString

public String toString()

Overrides:

toString in class Object