org.pfsw.file

Class PropertiesFileContent

java.lang.Object

java.util.Dictionary<K,V>

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

java.util.Properties

org.pfsw.util.OrderedProperties<org.pfsw.file.PropertiesFileElement>

org.pfsw.file.PropertiesFileContent

All Implemented Interfaces:

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

public class PropertiesFileContent
extends OrderedProperties<org.pfsw.file.PropertiesFileElement>

Represents a properties collection with empty lines and comments. The order will be preserved.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pfsw.util.OrderedProperties

INITIAL_CAPACITY

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addElement(org.pfsw.file.PropertiesFileElement element)
void	addLine(java.lang.String line) Adds the given line at the end of all contained elements
boolean	addProperty(IName name, java.lang.String value) Adds the property with the specified name and value.
boolean	addProperty(java.lang.String name, java.lang.String value) Adds the property with the specified name and value.
boolean	commentProperty(IName name) Turns the property specified by the given name to a comment.
boolean	commentProperty(java.lang.String name) Turns the property specified by the given name to a comment.
protected org.pfsw.file.PropertiesFileElement	elementAt(int index)
protected org.pfsw.file.PropertiesFileElement	elementAt(java.lang.Integer index)
protected org.pfsw.file.PropertiesFileElement	findPropertyElement(java.lang.String key)
protected java.util.List<java.lang.Integer>	getCommentIndex()
protected boolean	isValidProperty(org.pfsw.file.PropertiesFileElement property)
boolean	modifyProperty(IName name, java.lang.String newValue) Modifies the value of the property specified by the given name.
boolean	modifyProperty(java.lang.String name, java.lang.String newValue) Modifies the value of the property specified by the given name.
protected org.pfsw.file.PropertiesFileElement	newProperty(java.lang.String name, java.lang.String value) Create a new property object with the given name and value.
protected void	registerComment(java.lang.Integer index)
boolean	renameProperty(IName name, IName newName) Renames the the property specified with the given name to the specified new name.
boolean	renameProperty(java.lang.String name, java.lang.String newName) Renames the the property specified with the given name to the specified new name.
protected void	setCommentIndex(java.util.List<java.lang.Integer> newValue)
java.lang.Object	setProperty(java.lang.String name, java.lang.String value) Modifies the value or adds the property specified by the given name.
boolean	uncommentProperty(IName name) Changes a comment containing the property specified by the given name to a real property setting, by removing the leading comment indicator '#'.
boolean	uncommentProperty(java.lang.String name) Changes a comment containing the property specified by the given name to a real property setting, by removing the leading comment indicator '#'.

Methods inherited from class org.pfsw.util.OrderedProperties

appendProperty, clear, deleteProperty, deleteProperty, entrySet, findProperty, getElements, getProperty, getProperty, getProperty, getProperty, getPropertyIndex, getPropertyNames, hasContent, indexOfProperty, isEmpty, isNullOrDeleted, keys, keySet, list, list, load, nameList, newElementsList, numberOfElements, propertyAt, propertyAt, propertyNames, registerProperty, remove, save, setElements, setProperty, setPropertyIndex, size, store, 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

Constructor Detail

PropertiesFileContent

public PropertiesFileContent()

Initialize the new instance with default values.

PropertiesFileContent

public PropertiesFileContent(int initialCapacity)

Initialize the new instance with an initial capacity.

Method Detail

addLine

public void addLine(java.lang.String line)

Adds the given line at the end of all contained elements

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 if the property was found and modified or added, otherwise false.

Overrides:

setProperty in class OrderedProperties<org.pfsw.file.PropertiesFileElement>

Parameters:

name - The name of the property to set

value - The new value to be set

modifyProperty

public boolean modifyProperty(java.lang.String name,
                              java.lang.String newValue)

Modifies the value of the property specified by the given name. Returns true if the property was found and modified, otherwise false.

Parameters:

name - The name of the property to modify

newValue - The new value to be set

modifyProperty

public boolean modifyProperty(IName name,
                              java.lang.String newValue)

Modifies the value of the property specified by the given name. Returns true if the property was found and modified, otherwise false.

Parameters:

name - The name of the property to modify

newValue - The new value to be set

renameProperty

public boolean renameProperty(java.lang.String name,
                              java.lang.String newName)

Renames the the property specified with the given name to the specified new name. Returns true if the property was found and renamed, otherwise false.

Parameters:

name - The name of the property to rename.

newName - The new name to be set.

renameProperty

public boolean renameProperty(IName name,
                              IName newName)

Renames the the property specified with the given name to the specified new name. Returns true if the property was found and renamed, otherwise false.

Parameters:

name - The name of the property to rename.

newName - The new name to be set.

addProperty

public boolean addProperty(java.lang.String name,
                           java.lang.String value)

Adds the property with the specified name and value. Returns true if the property was added, otherwise false. In particular it will not be added if a property with the same name already exists (returns false then).

Parameters:

name - The name of the property to add.

value - The value to be set.

addProperty

public boolean addProperty(IName name,
                           java.lang.String value)

Adds the property with the specified name and value. Returns true if the property was added, otherwise false. In particular it will not be added if a property with the same name already exists (returns false then).

Parameters:

name - The name of the property to add.

value - The value to be set.

commentProperty

public boolean commentProperty(java.lang.String name)

Turns the property specified by the given name to a comment. Returns true if the property was found and changed to a comment, otherwise false.

Parameters:

name - The name of the property to change to be a comment.

commentProperty

public boolean commentProperty(IName name)

Turns the property specified by the given name to a comment. Returns true if the property was found and changed to a comment, otherwise false.

Parameters:

name - The name of the property to change to be a comment.

uncommentProperty

public boolean uncommentProperty(java.lang.String name)

Changes a comment containing the property specified by the given name to a real property setting, by removing the leading comment indicator '#'. Returns true if the property was found in a comment and changed to a non-comment, otherwise false.

Parameters:

name - The name of the property to change from a comment to a property.

uncommentProperty

public boolean uncommentProperty(IName name)

Changes a comment containing the property specified by the given name to a real property setting, by removing the leading comment indicator '#'. Returns true if the property was found in a comment and changed to a non-comment, otherwise false.

Parameters:

name - The name of the property to change from a comment to a property.

newProperty

protected org.pfsw.file.PropertiesFileElement 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.

Overrides:

newProperty in class OrderedProperties<org.pfsw.file.PropertiesFileElement>

addElement

protected void addElement(org.pfsw.file.PropertiesFileElement element)

Overrides:

addElement in class OrderedProperties<org.pfsw.file.PropertiesFileElement>

findPropertyElement

protected org.pfsw.file.PropertiesFileElement findPropertyElement(java.lang.String key)

elementAt

protected org.pfsw.file.PropertiesFileElement elementAt(java.lang.Integer index)

elementAt

protected org.pfsw.file.PropertiesFileElement elementAt(int index)

registerComment

protected void registerComment(java.lang.Integer index)

isValidProperty

protected boolean isValidProperty(org.pfsw.file.PropertiesFileElement property)

Overrides:

isValidProperty in class OrderedProperties<org.pfsw.file.PropertiesFileElement>

getCommentIndex

protected java.util.List<java.lang.Integer> getCommentIndex()

setCommentIndex

protected void setCommentIndex(java.util.List<java.lang.Integer> newValue)