org.pfsw.util

Class CaseInsensitiveMultiValueProperties<ValueType>

java.lang.Object

org.pfsw.util.CaseInsensitiveMultiValueProperties<ValueType>

All Implemented Interfaces:

IReadOnlyNamedValues<java.util.List<ValueType>>

public class CaseInsensitiveMultiValueProperties<ValueType>
extends java.lang.Object
implements IReadOnlyNamedValues<java.util.List<ValueType>>

A map which holds named multi-value properties and allows case-insensitive access to them by their names.

Constructor Summary

Constructors

Constructor and Description
CaseInsensitiveMultiValueProperties() Initialize the new instance with default values (allowDuplicateValues=false).
CaseInsensitiveMultiValueProperties(boolean allowDuplicateValues) Initialize the new instance with a flag that specifies whether or not to allow duplicate values.

Method Summary

Modifier and Type	Method and Description
void	addValues(java.lang.String name, ValueType... values) Add one or more values to the property with the given name.
void	clear() Removes all hold data.
void	clearValues(java.lang.String name)
boolean	contains(java.lang.String name)
protected java.util.Map<java.lang.String,MultiValueProperty<ValueType>>	createEmptyMap()
boolean	getAllowDuplicates()
java.util.Set<java.lang.String>	getNames() Returns the names of all properties held in this container.
protected MultiValueProperty<ValueType>	getOrCreate(java.lang.String name)
protected java.util.Map<java.lang.String,MultiValueProperty<ValueType>>	getProperties()
MultiValueProperty<ValueType>	getProperty(java.lang.String name) Returns the property with the given name or null if not found.
java.util.List<ValueType>	getValue(java.lang.String name) Returns the values of the specified property or null if not found.
java.util.List<ValueType>	getValues(java.lang.String name) Returns the values of the specified property or null if not found.
boolean	isEmpty() Returns true if the receiver does not contain any data.
void	remove(java.lang.String... names)
void	removeValues(java.lang.String name, ValueType... values)
protected void	setAllowDuplicates(boolean newValue)
protected void	setProperties(java.util.Map<java.lang.String,MultiValueProperty<ValueType>> newValue)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

CaseInsensitiveMultiValueProperties

public CaseInsensitiveMultiValueProperties()

Initialize the new instance with default values (allowDuplicateValues=false).

CaseInsensitiveMultiValueProperties

public CaseInsensitiveMultiValueProperties(boolean allowDuplicateValues)

Initialize the new instance with a flag that specifies whether or not to allow duplicate values. If set to false duplicate values will be silently skipped when tried to be added.

Method Detail

getNames

public java.util.Set<java.lang.String> getNames()

Returns the names of all properties held in this container.

Specified by:

getNames in interface IReadOnlyNamedValues<java.util.List<ValueType>>

getAllowDuplicates

public boolean getAllowDuplicates()

getProperty

public MultiValueProperty<ValueType> getProperty(java.lang.String name)

Returns the property with the given name or null if not found.

getValues

public java.util.List<ValueType> getValues(java.lang.String name)

Returns the values of the specified property or null if not found.

Parameters:

name - The propertie's name (must not be null).

getValue

public java.util.List<ValueType> getValue(java.lang.String name)

Returns the values of the specified property or null if not found.

Specified by:

getValue in interface IReadOnlyNamedValues<java.util.List<ValueType>>

Parameters:

name - The propertie's name (must not be null).

Returns:

The values associated with the name or null if the name is unknown.

addValues

public void addValues(java.lang.String name,
                      ValueType... values)

Add one or more values to the property with the given name. Not yet existing properties will be created automatically. This can also be used to create a new property with an empty value list (e.g. addValues("prop")).

Parameters:

name - The name of the property (must not be null)

values - The values to be added - may be omitted completely (must not be null)

contains

public boolean contains(java.lang.String name)

remove

public void remove(java.lang.String... names)

removeValues

public void removeValues(java.lang.String name,
                         ValueType... values)

clearValues

public void clearValues(java.lang.String name)

clear

public void clear()

Removes all hold data.

isEmpty

public boolean isEmpty()

Description copied from interface: IReadOnlyNamedValues

Returns true if the receiver does not contain any data.

Specified by:

isEmpty in interface IReadOnlyNamedValues<java.util.List<ValueType>>

size

public int size()

getOrCreate

protected MultiValueProperty<ValueType> getOrCreate(java.lang.String name)

createEmptyMap

protected java.util.Map<java.lang.String,MultiValueProperty<ValueType>> createEmptyMap()

getProperties

protected java.util.Map<java.lang.String,MultiValueProperty<ValueType>> getProperties()

setProperties

protected void setProperties(java.util.Map<java.lang.String,MultiValueProperty<ValueType>> newValue)

setAllowDuplicates

protected void setAllowDuplicates(boolean newValue)