Package com.tangosol.coherence.config

Class SimpleParameterList

java.lang.Object

com.tangosol.coherence.config.SimpleParameterList

All Implemented Interfaces:

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

public class SimpleParameterList
extends Object
implements ParameterList, ExternalizableLite, PortableObject

A SimpleParameterList is a simple implementation of ParameterList.

Since:

Coherence 12.1.2

Author:

bo 2012.02.02

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SimpleParameterList()	Constructs an empty SimpleParameterList.
SimpleParameterList(ParameterList listParameters)	Constructs a SimpleParameterList based on a ParameterList.
SimpleParameterList(Object... aObjects)	Constructs a SimpleParameterList based on the specified array of objects, each object becoming it's own Parameter in the resulting list.

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.
void	add(Object o)	Adds the specified object to the end of the ParameterList as an anonymous Parameter.
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.
int	size()	Obtains the number of Parameters in the ParameterList.
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, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SimpleParameterList

public SimpleParameterList()

Constructs an empty SimpleParameterList.

SimpleParameterList

public SimpleParameterList(Object... aObjects)

Constructs a SimpleParameterList based on the specified array of objects, each object becoming it's own Parameter in the resulting list.

Parameters:

aObjects - the objects to be considered as parameters

SimpleParameterList

public SimpleParameterList(ParameterList listParameters)

Constructs a SimpleParameterList based on a ParameterList.

Parameters:

listParameters - the ParameterList from which Parameters should be drawn

Method Detail

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>

add

public void add(Object o)

Adds the specified object to the end of the ParameterList as an anonymous Parameter.

Parameters:

o - the object to add as a 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