org.pfsw.util

Class OrderedProperties<T extends IMutableStringPair>

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

org.pfsw.util.OrderedProperties<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

Direct Known Subclasses:

PropertiesFileContent

public class OrderedProperties<T extends IMutableStringPair>
extends java.util.Properties

Represents a properties collection with empty lines and comments. The order will be preserved. DO NOT USE THE NORMAL METHODS INHERITED FROM java.util.Hashtable except those that are explicitly overridden in this class!

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	INITIAL_CAPACITY

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
OrderedProperties() Initialize the new instance with default values.
OrderedProperties(int initialCapacity) Initialize the new instance with an initial capacity.

Method Summary

Modifier and Type	Method and Description
protected void	addElement(T element)
protected boolean	appendProperty(java.lang.String name, java.lang.String value) Appends the property specified by the given name with the given value..
void	clear() Removes all properties
boolean	deleteProperty(IName name) Deletes the property with the specified name.
boolean	deleteProperty(java.lang.String name) Deletes the property with the specified name.
java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>>	entrySet() Returns all entries in the order they have been added
protected T	findProperty(java.lang.String key)
protected java.util.List<T>	getElements()
java.lang.String	getProperty(IName name) Returns the value of the property with the given name or null if it is not found.
java.lang.String	getProperty(IName name, java.lang.String defaultValue) Searches for the property with the specified key in this property list.
java.lang.String	getProperty(java.lang.String name) Returns the value of the property with the given name or null if it is not found.
java.lang.String	getProperty(java.lang.String name, java.lang.String defaultValue) Searches for the property with the specified name in this property list.
protected java.util.Map<java.lang.String,java.lang.Integer>	getPropertyIndex()
java.lang.String[]	getPropertyNames() Returns an array containing the properties names in the order they have been added or read from a stream.
boolean	hasContent() Returns whether or not any data is contained.
protected java.lang.Integer	indexOfProperty(java.lang.String key)
boolean	isEmpty() Returns whether or not this contains any properties.
protected boolean	isNullOrDeleted(T property) Returns true if the given property is null or marked as deleted.
protected boolean	isValidProperty(T property)
java.util.Enumeration<java.lang.Object>	keys() Returns all keys of this properties list in the order they have been added.
java.util.Set<java.lang.Object>	keySet() Returns all keys of this properties list in the order they have been added.
void	list(java.io.PrintStream out) NOT SUPPORTED METHOD!
void	list(java.io.PrintWriter out) NOT SUPPORTED METHOD!
void	load(java.io.InputStream inStream) NOT SUPPORTED METHOD!
java.util.List<java.lang.String>	nameList() Returns a list containing all properties names in the order they have been added or read from a stream.
protected java.util.List<T>	newElementsList(int initialCapacity)
protected T	newProperty(java.lang.String name, java.lang.String value) Create a new property object with the given name and value.
int	numberOfElements() Returns how many elements are contained.
protected T	propertyAt(int index)
protected T	propertyAt(java.lang.Integer index)
java.util.Enumeration<java.lang.String>	propertyNames() Returns an enumeration of the properties names in the order they have been added or read from a stream.
protected void	registerProperty(T property, java.lang.Integer index)
java.lang.Object	remove(java.lang.Object key) Removes the key (and its corresponding value) from this hashtable.
void	save(java.io.OutputStream out, java.lang.String header) Deprecated.
protected void	setElements(java.util.List<T> newValue)
java.lang.Object	setProperty(IName name, java.lang.String value) Modifies the value or adds the property specified by the given name.
java.lang.Object	setProperty(java.lang.String name, java.lang.String value) Modifies the value or adds the property specified by the given name.
protected void	setPropertyIndex(java.util.Map<java.lang.String,java.lang.Integer> newValue)
int	size() Returns how many properties are contained.
void	store(java.io.OutputStream out, java.lang.String header) NOT SUPPORTED METHOD!
java.util.Set<java.lang.String>	stringPropertyNames()

Methods inherited from class java.util.Properties

load, loadFromXML, store, storeToXML, storeToXML

Methods inherited from class java.util.Hashtable

clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, equals, forEach, get, getOrDefault, hashCode, merge, put, putAll, putIfAbsent, rehash, remove, replace, replace, replaceAll, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INITIAL_CAPACITY

protected static final int INITIAL_CAPACITY

See Also:

Constant Field Values

Constructor Detail

OrderedProperties

public OrderedProperties()

Initialize the new instance with default values.

OrderedProperties

public OrderedProperties(int initialCapacity)

Initialize the new instance with an initial capacity.

Method Detail

nameList

public java.util.List<java.lang.String> nameList()

Returns a list containing all properties names in the order they have been added or read from a stream.

getPropertyNames

public java.lang.String[] getPropertyNames()

Returns an array containing the properties names in the order they have been added or read from a stream.

size

public int size()

Returns how many properties are contained. That does NOT include empty and comment lines!

Specified by:

size in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

size in class java.util.Hashtable<java.lang.Object,java.lang.Object>

See Also:

numberOfElements()

numberOfElements

public int numberOfElements()

Returns how many elements are contained. That includes empty and comment lines!

See Also:

size()

isEmpty

public boolean isEmpty()

Returns whether or not this contains any properties. Empty and comment lines are ignored here.

Specified by:

isEmpty in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

isEmpty in class java.util.Hashtable<java.lang.Object,java.lang.Object>

See Also:

hasContent()

hasContent

public boolean hasContent()

Returns whether or not any data is contained. That includes empty and comment lines are ignored here. So this method can return true even if no property is defined.

See Also:

isEmpty()

getProperty

public java.lang.String getProperty(java.lang.String name)

Returns the value of the property with the given name or null if it is not found.

Overrides:

getProperty in class java.util.Properties

Parameters:

name - The name of the property to look for.

getProperty

public java.lang.String getProperty(IName name)

Returns the value of the property with the given name or null if it is not found.

Parameters:

name - The name of the property to look for.

setProperty

public java.lang.Object setProperty(java.lang.String name,
                                    java.lang.String value)

Modifies the value or adds the property specified by the given name. Returns true the previous value if the property was found and modified or null if the property was added.

Overrides:

setProperty in class java.util.Properties

Parameters:

name - The name of the property to set

value - The new value to be set

setProperty

public java.lang.Object setProperty(IName name,
                                    java.lang.String value)

Modifies the value or adds the property specified by the given name. Returns true the previous value if the property was found and modified or null if the property was added.

Parameters:

name - The name of the property to set.

value - The new value to be set.

deleteProperty

public boolean deleteProperty(java.lang.String name)

Deletes the property with the specified name. Returns true if the property was deleted, otherwise false.

Parameters:

name - The name of the property to delete

deleteProperty

public boolean deleteProperty(IName name)

Deletes the property with the specified name. Returns true if the property was deleted, otherwise false.

Parameters:

name - The name of the property to delete.

remove

public java.lang.Object remove(java.lang.Object key)

Removes the key (and its corresponding value) from this hashtable. This method does nothing if the key is not found.

Specified by:

remove in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

remove in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Returns:

the value to which the key had been mapped, or null if the key did not have a mapping.

getProperty

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

Searches for the property with the specified name in this property list. If the name is not found in this property list the method returns the default value argument.

Overrides:

getProperty in class java.util.Properties

getProperty

public java.lang.String getProperty(IName name,
                                    java.lang.String defaultValue)

Searches for the property with the specified key in this property list. If the key is not found in this property list the method returns the default value argument.

list

public void list(java.io.PrintStream out)

NOT SUPPORTED METHOD!

Overrides:

list in class java.util.Properties

Throws:

java.lang.UnsupportedOperationException

list

public void list(java.io.PrintWriter out)

NOT SUPPORTED METHOD!

Overrides:

list in class java.util.Properties

Throws:

java.lang.UnsupportedOperationException

load

public void load(java.io.InputStream inStream)
          throws java.io.IOException

NOT SUPPORTED METHOD!

Overrides:

load in class java.util.Properties

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

propertyNames

public java.util.Enumeration<java.lang.String> propertyNames()

Returns an enumeration of the properties names in the order they have been added or read from a stream.

Be aware that the returned enumeration is NOT backed by this OrderedProperties object!

Overrides:

propertyNames in class java.util.Properties

stringPropertyNames

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

Overrides:

stringPropertyNames in class java.util.Properties

save

@Deprecated
public void save(java.io.OutputStream out,
                              java.lang.String header)

Deprecated.

NOT SUPPORTED METHOD!

Overrides:

save in class java.util.Properties

Throws:

java.lang.UnsupportedOperationException

store

public void store(java.io.OutputStream out,
                  java.lang.String header)
           throws java.io.IOException

NOT SUPPORTED METHOD!

Overrides:

store in class java.util.Properties

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

clear

public void clear()

Removes all properties

Specified by:

clear in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

clear in class java.util.Hashtable<java.lang.Object,java.lang.Object>

keys

public java.util.Enumeration<java.lang.Object> keys()

Returns all keys of this properties list in the order they have been added.

Overrides:

keys in class java.util.Hashtable<java.lang.Object,java.lang.Object>

keySet

public java.util.Set<java.lang.Object> keySet()

Returns all keys of this properties list in the order they have been added.

Specified by:

keySet in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

keySet in class java.util.Hashtable<java.lang.Object,java.lang.Object>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.Object,java.lang.Object>> entrySet()

Returns all entries in the order they have been added

Specified by:

entrySet in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

entrySet in class java.util.Hashtable<java.lang.Object,java.lang.Object>

appendProperty

protected boolean appendProperty(java.lang.String name,
                                 java.lang.String value)

Appends the property specified by the given name with the given value.. Returns true if the property was successfully added at the end, otherwise false.

Parameters:

name - The name of the property to append

value - The new value to be append

newProperty

protected T newProperty(java.lang.String name,
                        java.lang.String value)

Create a new property object with the given name and value. Subclasses may override this to implement their own property class.

addElement

protected void addElement(T element)

registerProperty

protected void registerProperty(T property,
                                java.lang.Integer index)

findProperty

protected T findProperty(java.lang.String key)

indexOfProperty

protected java.lang.Integer indexOfProperty(java.lang.String key)

propertyAt

protected T propertyAt(java.lang.Integer index)

propertyAt

protected T propertyAt(int index)

isNullOrDeleted

protected boolean isNullOrDeleted(T property)

Returns true if the given property is null or marked as deleted. Subclasses may override this method to enhance behavior.

Parameters:

property - The property to check

Returns:

true if the given property is null or marked as deleted

isValidProperty

protected boolean isValidProperty(T property)

newElementsList

protected java.util.List<T> newElementsList(int initialCapacity)

getElements

protected java.util.List<T> getElements()

setElements

protected void setElements(java.util.List<T> newValue)

getPropertyIndex

protected java.util.Map<java.lang.String,java.lang.Integer> getPropertyIndex()

setPropertyIndex

protected void setPropertyIndex(java.util.Map<java.lang.String,java.lang.Integer> newValue)