org.pfsw.util

Class MultiValueProperty<ValueType>

java.lang.Object

org.pfsw.util.MultiValueProperty<ValueType>

Direct Known Subclasses:

MultiStringProperty

public class MultiValueProperty<ValueType>
extends java.lang.Object

This represents a single property with a name and a list of multiple values.

Constructor Summary

Constructors

Constructor and Description
MultiValueProperty(java.lang.String name, boolean allowDuplicateValues, ValueType... values) Initialize the new instance with a name and define whether or not duplicate values are allowed.
MultiValueProperty(java.lang.String name, ValueType... values) Initialize the new instance with a name.

Method Summary

Modifier and Type	Method and Description
protected boolean	addValue(ValueType value) Add the given value to the list of values.
boolean	addValues(ValueType... values) Add the given values to the list of values.
void	clearValues() Remove all values;
boolean	containsValue(ValueType value) Returns true if the given value is already in the list of values.
boolean	equals(java.lang.Object obj) Returns true if the given object is a MultiValueProperty with the same name (case-sensitive) as this MultiValueProperty instance.
boolean	getAllowDuplicates()
ValueType	getFirstValue() Returns the first value of the internal list of values or null if no values are available.
java.lang.String	getName() Returns the name of this property.
protected NamedValue<java.util.List<ValueType>>	getNamedValues()
java.util.List<ValueType>	getValues() Returns a list of the values.
int	hashCode()
boolean	hasValues() Returns true if at least one value is in the list of values.
boolean	isEmpty() Returns true if no value is in the list of values.
int	numberOfValues() Returns the number of values in the list of values,
protected boolean	removeValue(ValueType value) Remove the given value from the list of values.
boolean	removeValues(ValueType... values) Remove the given values from the list of values.
void	setAllowDuplicates(boolean newValue)
protected void	setNamedValues(NamedValue<java.util.List<ValueType>> newValue)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiValueProperty

public MultiValueProperty(java.lang.String name,
                          ValueType... values)

Initialize the new instance with a name.

MultiValueProperty

public MultiValueProperty(java.lang.String name,
                          boolean allowDuplicateValues,
                          ValueType... values)

Initialize the new instance with a name and define whether or not duplicate values are allowed.

Method Detail

getName

public java.lang.String getName()

Returns the name of this property.

getAllowDuplicates

public boolean getAllowDuplicates()

setAllowDuplicates

public void setAllowDuplicates(boolean newValue)

addValues

public boolean addValues(ValueType... values)

Add the given values to the list of values.

Parameters:

values - The values to add.

Returns:

true if at least one value was added.

removeValues

public boolean removeValues(ValueType... values)

Remove the given values from the list of values.

Parameters:

values - The values to remove.

Returns:

true if at least one value was in the list and has been removed.

containsValue

public boolean containsValue(ValueType value)

Returns true if the given value is already in the list of values.

getValues

public java.util.List<ValueType> getValues()

Returns a list of the values. This is a copy of the internal list, so it might be modified without side-effects to this property.

getFirstValue

public ValueType getFirstValue()

Returns the first value of the internal list of values or null if no values are available.

clearValues

public void clearValues()

Remove all values;

isEmpty

public boolean isEmpty()

Returns true if no value is in the list of values.

hasValues

public boolean hasValues()

Returns true if at least one value is in the list of values.

numberOfValues

public int numberOfValues()

Returns the number of values in the list of values,

equals

public boolean equals(java.lang.Object obj)

Returns true if the given object is a MultiValueProperty with the same name (case-sensitive) as this MultiValueProperty instance.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

addValue

protected boolean addValue(ValueType value)

Add the given value to the list of values.

Parameters:

value - The value to add.

Returns:

true if the value was added.

removeValue

protected boolean removeValue(ValueType value)

Remove the given value from the list of values.

Parameters:

value - The value to remove.

Returns:

true if the value was in the list and has been removed.

getNamedValues

protected NamedValue<java.util.List<ValueType>> getNamedValues()

setNamedValues

protected void setNamedValues(NamedValue<java.util.List<ValueType>> newValue)