Package net.officefloor.compile.impl.properties

Class PropertyListImpl

java.lang.Object

net.officefloor.compile.impl.properties.PropertyListImpl

All Implemented Interfaces:

java.lang.Iterable<Property>, PropertyList

public class PropertyListImpl
extends java.lang.Object
implements PropertyList

Implementation of the PropertyList.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
PropertyListImpl(java.lang.String... nameValuePairs)	Initiate.

Method Summary

Modifier and Type	Method	Description
Property	addProperty(java.lang.String name)	Appends a Property to this PropertyList.
Property	addProperty(java.lang.String name, java.lang.String label)	Appends a Property to this PropertyList.
void	clear()	Clears the PropertyList.
void	configureProperties(PropertyConfigurable configurable)	Loads the Property values of this PropertyList to PropertyConfigurable.
Property	getOrAddProperty(java.lang.String name)	Convenience method that attempts to get the Property and if not found adds the Property.
java.util.Properties	getProperties()	Obtains the Properties populated with the Property values.
Property	getProperty(java.lang.String name)	Obtains the first Property by the input name.
java.lang.String[]	getPropertyNames()	Obtains the names of the Property instances in the order they were added.
java.lang.String	getPropertyValue(java.lang.String name, java.lang.String defaultValue)	Convenience method to obtain the Property value.
java.util.Iterator<Property>	iterator()
void	normalise()	Normalises the Property instances.
void	removeProperty(Property property)	Removes the Property from this PropertyList.
void	sort(java.util.Comparator<? super Property> comparator)	Enable sorting the Property instances within this PropertyList.

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

PropertyListImpl

public PropertyListImpl(java.lang.String... nameValuePairs)

Initiate.

Parameters:

nameValuePairs - Property name/values to initially populate this list.

Method Detail

iterator

public java.util.Iterator<Property> iterator()

Specified by:

iterator in interface java.lang.Iterable<Property>

addProperty

public Property addProperty(java.lang.String name,
                            java.lang.String label)

Description copied from interface: PropertyList

Appends a Property to this PropertyList.

Specified by:

addProperty in interface PropertyList

Parameters:

name - Name of the Property.

label - Label of the Property. Should this be blank it will be defaulted to the name.

Returns:

Property added.

addProperty

public Property addProperty(java.lang.String name)

Description copied from interface: PropertyList

Appends a Property to this PropertyList.

Specified by:

addProperty in interface PropertyList

Parameters:

name - Name of the Property which is also used as the label.

Returns:

Property added.

removeProperty

public void removeProperty(Property property)

Description copied from interface: PropertyList

Removes the Property from this PropertyList.

Specified by:

removeProperty in interface PropertyList

Parameters:

property - Property to be removed.

getPropertyNames

public java.lang.String[] getPropertyNames()

Description copied from interface: PropertyList

Obtains the names of the Property instances in the order they were added.

Specified by:

getPropertyNames in interface PropertyList

Returns:

Names of the Property instances.

getProperty

public Property getProperty(java.lang.String name)

Description copied from interface: PropertyList

Obtains the first Property by the input name.

Specified by:

getProperty in interface PropertyList

Parameters:

name - Name of the Property to return.

Returns:

First Property by the input name, or null if no Property by the name.

getOrAddProperty

public Property getOrAddProperty(java.lang.String name)

Description copied from interface: PropertyList

Convenience method that attempts to get the Property and if not found adds the Property.

Specified by:

getOrAddProperty in interface PropertyList

Parameters:

name - Name of the Property to return.

Returns:

First Property by the input name or a newly added Property if no Property found by the name.

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name,
                                         java.lang.String defaultValue)

Description copied from interface: PropertyList

Convenience method to obtain the Property value.

Specified by:

getPropertyValue in interface PropertyList

Parameters:

name - Name of the Property to obtain its value.

defaultValue - Default value should the Property not exist or have blank value.

Returns:

Value for the Property (or defaultValue if not available).

getProperties

public java.util.Properties getProperties()

Description copied from interface: PropertyList

Obtains the Properties populated with the Property values.

Specified by:

getProperties in interface PropertyList

Returns:

Populated Properties.

clear

public void clear()

Description copied from interface: PropertyList

Clears the PropertyList.

Specified by:

clear in interface PropertyList

sort

public void sort(java.util.Comparator<? super Property> comparator)

Description copied from interface: PropertyList

Enable sorting the Property instances within this PropertyList.

Specified by:

sort in interface PropertyList

Parameters:

comparator - Comparator to provide comparisons for sorting.

normalise

public void normalise()

Description copied from interface: PropertyList

Normalises the Property instances.

This will remove:

1. any Property with a blank name
2. any Property with a blank value
3. duplicate Property instances by the same name (keeps the first Property)

Specified by:

normalise in interface PropertyList

configureProperties

public void configureProperties(PropertyConfigurable configurable)

Description copied from interface: PropertyList

Loads the Property values of this PropertyList to PropertyConfigurable.

Specified by:

configureProperties in interface PropertyList

Parameters:

configurable - PropertyConfigurable to be configured with the Property values.