com.bmc.arsys.plugins.ftsconfig.helper.shared

Class PropertiesConfigurationFile

java.lang.Object

com.bmc.arsys.plugins.ftsconfig.helper.shared.AbstractConfigurationFile

com.bmc.arsys.plugins.ftsconfig.helper.shared.PropertiesConfigurationFile

All Implemented Interfaces:

AbstractEntryContainer, Iterable<AbstractEntry>

public class PropertiesConfigurationFile
extends AbstractConfigurationFile

PropertiesConfigurationFile represents a Java properties File. The difference between this class and the java.util.Properties class is this class preserves the order of properties as well as comments and blank lines when saving. The java.util.Properties class will delete all comments and will reorder the properties based on the hash order of the property names. So this class provides a nice formatted output that can retain the original human-friendly and informative extra data and ordering. This class is also capable of holding multiple values for a given key depending on whether allowing multiple values per key is turned on. The PropertiesConfigurationFile by default uses ISO-8859-1 encoding to match the convention for Java property files. This can be changed by calling setCharsetName. If a value of null is used for the charset name, the platform default will be used. Otherwise, the charset name specified will be used.

See Also:

Properties

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISO_8859_1

Constructor Summary

Constructors

Constructor and Description
PropertiesConfigurationFile() Constructor for PropertiesConfigurationFile with encoding Unicode turned off and allowing multiple values per key turned off

Method Summary

Methods

Modifier and Type	Method and Description
void	addComment(String comment) Adds a comment
void	addComment(String commentStartToken, String comment) Adds a comment
void	addCommentStartToken(String commentStartToken) Adds a comment start token
void	addProperty(PropertyEntry property) Adds a property to the list.
void	addProperty(String key, String value) Adds a property to the list.
boolean	allowsEntryType(AbstractEntry entry) Determines if an entry type is allowed in this configuration File
void	commentProperty(String commentStartToken, PropertyEntry property)
void	commentProperty(String commentStartToken, String key)
void	deleteProperty(PropertyEntry property) Deletes a property entry
void	deleteProperty(String key) Deletes all the property values associated with this key
boolean	getAllowMultipleValuesPerKey() Gets whether to allow multiple values per key
String	getCharsetName() Gets the charset name The PropertiesConfigurationFile by default uses ISO-8859-1 encoding to match the convention for Java property files.
List<String>	getCommentStartTokens() Gets the comment start tokens
boolean	getEncodeUnicode() Gets whether to encode Unicode or not
String	getKeyValueSeparators() Gets the possible key value separator characters
List<String>	getProperties(String key) Gets all the property values for a given key
String	getProperty(String key) Gets a property value
PropertyEntry	getPropertyEntry(String key, String value)
String	getStrictKeyValueSeparators() Gets the strict key value separator characters
boolean	getUseKeySeparatorSpacing() Gets whether to use key separator spacing or not
boolean	getUseSeparatorValueSpacing() Gets whether to use separator value spacing or not
String	getWhitespaceCharacters() Gets the whitespace characters
void	parse(File file) Parses a File
void	parse(InputStream inputStream) Parses an input stream
void	removeComment(String comment) Removes a comment
void	removeCommentStartToken(String commentStartToken) Removes a comment start token
void	save(File file) Writes the current configuration to a File
void	setAllowMultipleValuesPerKey(boolean allowMultipleValuesPerKey) Sets whether a key can have multiple values or not
void	setCharsetName(String charsetName) Sets the charset name The PropertiesConfigurationFile by default uses ISO-8859-1 encoding to match the convention for Java property files.
void	setCommentStartTokens(List<String> commentStartTokens) Sets the comment start tokens
void	setEncodeUnicode(boolean encodeUnicode) Sets whether to encode Unicode or not
void	setKeyValueSeparators(String keyValueSeparators) Sets the possible key value separator characters
void	setProperties(Properties properties) Sets property values
void	setProperty(PropertyEntry property) Sets a property value
void	setProperty(String key, String value) Sets a property value
void	setStrictKeyValueSeparators(String strictKeyValueSeparators) Sets the strict key value separator characters
void	setUseKeySeparatorSpacing(boolean useKeySeparatorSpacing) Sets whether to use key separator spacing or not
void	setUseSeparatorValueSpacing(boolean useSeparatorValueSpacing) Sets whether to use separator value spacing or not
void	setWhitespaceCharacters(String whitespaceCharacters) Sets the whitespace characters
Properties	toProperties() Converts this to a Properties object

Methods inherited from class com.bmc.arsys.plugins.ftsconfig.helper.shared.AbstractConfigurationFile

addEntry, addEntry, equals, getConfigurationFileListIterator, getEntries, getEntry, hashCode, indexOfEntry, iterator, removeEntry, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ISO_8859_1

public static final String ISO_8859_1

See Also:

Constant Field Values

Constructor Detail

PropertiesConfigurationFile

public PropertiesConfigurationFile()

Constructor for PropertiesConfigurationFile with encoding Unicode turned off and allowing multiple values per key turned off

Method Detail

allowsEntryType

public boolean allowsEntryType(AbstractEntry entry)

Determines if an entry type is allowed in this configuration File

Parameters:

entry - entry to examine

Returns:

true if this type of entry is allowed, false otherwise

parse

public void parse(File file)
           throws FileNotFoundException,
                  IOException,
                  ParseException

Parses a File

Specified by:

parse in class AbstractConfigurationFile

Parameters:

file - File to parse

Throws:

FileNotFoundException - if the File is not found

IOException - for all other I/O errors

ParseException - for any parsing errors

parse

public void parse(InputStream inputStream)
           throws IOException,
                  ParseException

Parses an input stream

Parameters:

inputStream - input stream to parse

Throws:

IOException - for all other I/O errors

ParseException - for any parsing errors

save

public void save(File file)
          throws FileNotFoundException,
                 IOException

Writes the current configuration to a File

Overrides:

save in class AbstractConfigurationFile

Parameters:

file - File to write to

Throws:

FileNotFoundException - if the File is not found

IOException - for all other I/O errors

addComment

public void addComment(String comment)

Adds a comment

Parameters:

comment - comment to add

addComment

public void addComment(String commentStartToken,
              String comment)

Adds a comment

Parameters:

commentStartToken - comment start token

comment - comment to add

removeComment

public void removeComment(String comment)

Removes a comment

Parameters:

comment - comment to remove

getProperties

public List<String> getProperties(String key)

Gets all the property values for a given key

Parameters:

key - property key to look up

Returns:

all the property values for a given key

getProperty

public String getProperty(String key)

Gets a property value

Parameters:

key - property key to look up

Returns:

property value or null if key is not found

getPropertyEntry

public PropertyEntry getPropertyEntry(String key,
                             String value)

addProperty

public void addProperty(String key,
               String value)

Adds a property to the list. Existing properties with the same key are not affected if allowing multiple values per key.

Parameters:

key - property key to add

value - property value to add

addProperty

public void addProperty(PropertyEntry property)

Adds a property to the list. Existing properties with the same key are not affected if allowing multiple values per key.

Parameters:

property - PropertyEntry to add

setProperty

public void setProperty(String key,
               String value)

Sets a property value

Parameters:

key - property key to set

value - property value to set

setProperty

public void setProperty(PropertyEntry property)

Sets a property value

Parameters:

property - PropertyEntry to set

setProperties

public void setProperties(Properties properties)

Sets property values

Parameters:

properties - Properties to set

deleteProperty

public void deleteProperty(PropertyEntry property)

Deletes a property entry

Parameters:

property - Property to delete /** Deletes a property entry

property - PropertyEntry to delete

deleteProperty

public void deleteProperty(String key)

Deletes all the property values associated with this key

Parameters:

key - property key to delete

toProperties

public Properties toProperties()

Converts this to a Properties object

Returns:

Properties object

getCharsetName

public String getCharsetName()

Gets the charset name The PropertiesConfigurationFile by default uses ISO-8859-1 encoding to match the convention for Java property files. This can be changed by calling setCharsetName. If a value of null is used for the charset name, the platform default will be used. Otherwise, the charset name specified will be used.

Returns:

charset name

setCharsetName

public void setCharsetName(String charsetName)

Sets the charset name The PropertiesConfigurationFile by default uses ISO-8859-1 encoding to match the convention for Java property files. This can be changed by calling setCharsetName. If a value of null is used for the charset name, the platform default will be used. Otherwise, the charset name specified will be used.

Parameters:

charsetName - charset name

getEncodeUnicode

public boolean getEncodeUnicode()

Gets whether to encode Unicode or not

Returns:

whether to encode Unicode or not

setEncodeUnicode

public void setEncodeUnicode(boolean encodeUnicode)

Sets whether to encode Unicode or not

Parameters:

encodeUnicode - whether to encode Unicode or not

getAllowMultipleValuesPerKey

public boolean getAllowMultipleValuesPerKey()

Gets whether to allow multiple values per key

Returns:

true if a key can have multiple values, false otherwise

setAllowMultipleValuesPerKey

public void setAllowMultipleValuesPerKey(boolean allowMultipleValuesPerKey)

Sets whether a key can have multiple values or not

Parameters:

allowMultipleValuesPerKey - whether a key can have multiple values

getWhitespaceCharacters

public String getWhitespaceCharacters()

Gets the whitespace characters

Returns:

whitespace characters

setWhitespaceCharacters

public void setWhitespaceCharacters(String whitespaceCharacters)

Sets the whitespace characters

Parameters:

whitespaceCharacters - whitespace characters

getCommentStartTokens

public List<String> getCommentStartTokens()

Gets the comment start tokens

Returns:

comment start tokens

setCommentStartTokens

public void setCommentStartTokens(List<String> commentStartTokens)

Sets the comment start tokens

Parameters:

commentStartTokens - comment start tokens

addCommentStartToken

public void addCommentStartToken(String commentStartToken)

Adds a comment start token

Parameters:

commentStartToken - comment start token to add

removeCommentStartToken

public void removeCommentStartToken(String commentStartToken)

Removes a comment start token

Parameters:

commentStartToken - comment start token to remove

getStrictKeyValueSeparators

public String getStrictKeyValueSeparators()

Gets the strict key value separator characters

Returns:

strict key value separator characters

setStrictKeyValueSeparators

public void setStrictKeyValueSeparators(String strictKeyValueSeparators)

Sets the strict key value separator characters

Parameters:

strictKeyValueSeparators - strict key value separator characters

getKeyValueSeparators

public String getKeyValueSeparators()

Gets the possible key value separator characters

Returns:

possible key value separator characters

setKeyValueSeparators

public void setKeyValueSeparators(String keyValueSeparators)

Sets the possible key value separator characters

Parameters:

keyValueSeparators - possible key value separator characters

getUseKeySeparatorSpacing

public boolean getUseKeySeparatorSpacing()

Gets whether to use key separator spacing or not

Returns:

whether to use key separator spacing or not

setUseKeySeparatorSpacing

public void setUseKeySeparatorSpacing(boolean useKeySeparatorSpacing)

Sets whether to use key separator spacing or not

Parameters:

useKeySeparatorSpacing - whether to use key separator spacing or not

getUseSeparatorValueSpacing

public boolean getUseSeparatorValueSpacing()

Gets whether to use separator value spacing or not

Returns:

whether to use separator value spacing or not

setUseSeparatorValueSpacing

public void setUseSeparatorValueSpacing(boolean useSeparatorValueSpacing)

Sets whether to use separator value spacing or not

Parameters:

useSeparatorValueSpacing - whether to use separator value spacing or not

commentProperty

public void commentProperty(String commentStartToken,
                   String key)

commentProperty

public void commentProperty(String commentStartToken,
                   PropertyEntry property)