dk.heick.properties.types.utils

Class CommentedProperties

java.lang.Object

dk.heick.properties.types.utils.CommentedProperties

public class CommentedProperties
extends Object

Commented Properties, where it loads and saves comments as well.

Rules for general comments. These are comments which are at the top of a properties file, which describes the properties.

• General comments has to start with '##'
• General comments which starts with '##!' will be ignorred
• Will stop when it detects the first none '##' line which isn't empty.

Rules for property comments. There are comments which is description for the individual properties.

• A property comment is a none empty line which starts with either '#' or '!'.
• A comment which starts with '#!' will be ignored.
• It will take all comment from above a given property until the next property above it.

Example:

 ## General comment line 1
 ## General comment line 2
 ##!General comment line 3, is ignored and not loaded
 ## General comment line 4
 
 
 # Property A comment line 1
 A=1
 
 # Property B comment line 1
 # Property B comment line 2
 B=2
 
 ! Property C comment line 1
 ! Property C comment line 2
 
 C=3
 D=4
 
 # Property E comment line 1
 ! Property E comment line 2  
 E=5
 
 # Property F comment line 1
 #!Property F comment line 2, is ignored and not loaded
 ! Property F comment line 3  
 F=5 
 

Since:

1.4

Author:

Frederik Heick

Constructor Summary

Constructors

Constructor and Description
CommentedProperties() Constructor
CommentedProperties(Properties properties) Constructor with preset comments, not comments is set.

Method Summary

Modifier and Type	Method and Description
void	appendPropertiesComment(String comment) Appends a comment to the properties comment with a new line a front. Will only add the line if it is not null.
void	appendPropertyComment(String key, String comment) Appends a comment to the property comment with a new line a front. Will only add the line if it is not null.
Properties	getProperties() Gets the properties loaded.
List<String>	getPropertiesComment() Gets the general properties comments as a list og strings.
String	getPropertiesCommentAsString() Gets the general properties comments as a string Concatinated with a new line '\n'
int	getPropertiesWithCommentCount() Gets the number of properties with a comment attached.
List<String>	getPropertyComment(String key) Gets the comment for a property as a list of strings.
String	getPropertyCommentAsString(String key) Gets the comment for a property as a string Concatinated with a new line '\n'
Iterator<String>	getPropertyNames() Gets a iterator with all the property keys.
List<String>	getPropertyNamesAsList() Get a list of all property keys as a sorted unmodifiable list.
String	getPropertyValue(String key) Gets the value for a property.
boolean	hasPropertiesCommment() If there any general properties comment.
boolean	hasPropertyComment(String key) If there a comment to a given property.
void	load(File file) Loads the properties and comments from a file. All entries are reset when loading a new file.
void	load(String text) Loads the properties and comments from a string. All entries are reset when loading a new file.
void	setPropertiesComment(String comment) Set the general properties comment. The string will be split in lines for each new line.
void	setProperty(String key, String value) Sets a property value.
void	setProperty(String key, String value, String comment) Sets a property value and comment.
void	setPropertyComment(String key, String comment) Sets a property comment. The string will be split in lines for each new line.
int	size() The number of properties.
void	store(Writer writer) Writes this property list (key and element pairs) and comments in this Properties table to the output character stream in a format suitable for using the load(Reader) method. The writer is closed when done.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentedProperties

public CommentedProperties()

Constructor

CommentedProperties

public CommentedProperties(Properties properties)

Constructor with preset comments, not comments is set.

Parameters:

properties - the properties to use.

Method Detail

load

public void load(File file)
          throws IOException

Loads the properties and comments from a file.
All entries are reset when loading a new file.

Parameters:

file - the file

Throws:

IOException - if any IO exception.

See Also:

File

load

public void load(String text)
          throws IOException

Loads the properties and comments from a string.
All entries are reset when loading a new file.

Parameters:

text - the text containing properties and comments.

Throws:

IOException - if any IO exception.

store

public void store(Writer writer)
           throws IOException

Writes this property list (key and element pairs) and comments in this Properties table to the output character stream in a format suitable for using the load(Reader) method.
The writer is closed when done.

Parameters:

writer - the writer instance.

Throws:

IOException - if any IO exception.

See Also:

Writer

getPropertyNames

public Iterator<String> getPropertyNames()

Gets a iterator with all the property keys.

Returns:

the iterator with property keys.

getPropertyNamesAsList

public List<String> getPropertyNamesAsList()

Get a list of all property keys as a sorted unmodifiable list.

Returns:

a unmodifiable list of sorted property keys.

getPropertyValue

public String getPropertyValue(String key)

Gets the value for a property.

Parameters:

key - the property key.

Returns:

the value for the property.

getPropertyComment

public List<String> getPropertyComment(String key)

Gets the comment for a property as a list of strings.

Parameters:

key - the property key.

Returns:

a list of strings which are the comments for the property, if no comment for the property, than null is returned.

getPropertyCommentAsString

public String getPropertyCommentAsString(String key)

Gets the comment for a property as a string Concatinated with a new line '\n'

Parameters:

key - the property key.

Returns:

the property comment, if no comment for the property, than null is returned.

getPropertiesComment

public List<String> getPropertiesComment()

Gets the general properties comments as a list og strings.

Returns:

a list of strings which the general comment for the properties, if no comment, than null is returned.

getPropertiesCommentAsString

public String getPropertiesCommentAsString()

Gets the general properties comments as a string Concatinated with a new line '\n'

Returns:

the general properties, if no comment for the property, than null is returned.

hasPropertiesCommment

public boolean hasPropertiesCommment()

If there any general properties comment.

Returns:

true if the properties comment is not null and not empty after trim, otherwise false.

hasPropertyComment

public boolean hasPropertyComment(String key)

If there a comment to a given property.

Parameters:

key - the property key.

Returns:

@return true if the property comment is not null and not empty after trim, otherwise false.

setPropertiesComment

public void setPropertiesComment(String comment)

Set the general properties comment.
The string will be split in lines for each new line.

Parameters:

comment - the comment.

appendPropertiesComment

public void appendPropertiesComment(String comment)

Appends a comment to the properties comment with a new line a front.
Will only add the line if it is not null. If there is no current properties comment the line is just set with a new line.
The string will be split in lines for each new line.

Parameters:

comment - the comment to append.

setPropertyComment

public void setPropertyComment(String key,
                               String comment)

Sets a property comment.
The string will be split in lines for each new line.

Parameters:

key - the property key.

comment - the new property comment.

appendPropertyComment

public void appendPropertyComment(String key,
                                  String comment)

Appends a comment to the property comment with a new line a front.
Will only add the line if it is not null. If there is no current property comment the line is just set with a new line.

Parameters:

key - the property key.

comment - the comment to append.

setProperty

public void setProperty(String key,
                        String value)

Sets a property value.

Parameters:

key - the property key.

value - the new property value.

setProperty

public void setProperty(String key,
                        String value,
                        String comment)

Sets a property value and comment.

Parameters:

key - the property key.

value - the new property value.

comment - the new property comment.

size

public int size()

The number of properties.

Returns:

the number of properties.

getProperties

public Properties getProperties()

Gets the properties loaded.

Returns:

the properties

getPropertiesWithCommentCount

public int getPropertiesWithCommentCount()

Gets the number of properties with a comment attached.

Returns:

the comment count.