Class PropertiesConfiguration.PropertiesWriter
- java.lang.Object
-
- java.io.Writer
-
- java.io.FilterWriter
-
- org.apache.commons.configuration2.PropertiesConfiguration.PropertiesWriter
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.Appendable
,java.lang.AutoCloseable
- Direct Known Subclasses:
PropertiesConfiguration.JupPropertiesWriter
- Enclosing class:
- PropertiesConfiguration
public static class PropertiesConfiguration.PropertiesWriter extends java.io.FilterWriter
This class is used to write properties lines. The most important method iswriteProperty(String, Object, boolean)
, which is called during a save operation for each property found in the configuration.
-
-
Constructor Summary
Constructors Constructor Description PropertiesWriter(java.io.Writer writer, ListDelimiterHandler delHandler)
Creates a new instance ofPropertiesWriter
.PropertiesWriter(java.io.Writer writer, ListDelimiterHandler delHandler, ValueTransformer valueTransformer)
Creates a new instance ofPropertiesWriter
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
escapeKey(java.lang.String key)
Escapes the key of a property before it gets written to file.protected java.lang.String
fetchSeparator(java.lang.String key, java.lang.Object value)
Returns the separator to be used for the given property.java.lang.String
getCurrentSeparator()
Returns the current property separator.ListDelimiterHandler
getDelimiterHandler()
Returns the delimiter handler for properties with multiple values.java.lang.String
getGlobalSeparator()
Returns the global property separator.java.lang.String
getLineSeparator()
Returns the line separator.void
setCurrentSeparator(java.lang.String currentSeparator)
Sets the current property separator.void
setGlobalSeparator(java.lang.String globalSeparator)
Sets the global property separator.void
setLineSeparator(java.lang.String lineSeparator)
Sets the line separator.void
writeComment(java.lang.String comment)
Write a comment.void
writeln(java.lang.String s)
Helper method for writing a line with the platform specific line ending.void
writeProperty(java.lang.String key, java.lang.Object value)
Write a property.void
writeProperty(java.lang.String key, java.lang.Object value, boolean forceSingleLine)
Writes the given property and its value.void
writeProperty(java.lang.String key, java.util.List<?> values)
Write a property.
-
-
-
Constructor Detail
-
PropertiesWriter
public PropertiesWriter(java.io.Writer writer, ListDelimiterHandler delHandler)
Creates a new instance ofPropertiesWriter
.- Parameters:
writer
- a Writer object providing the underlying streamdelHandler
- the delimiter handler for dealing with properties with multiple values
-
PropertiesWriter
public PropertiesWriter(java.io.Writer writer, ListDelimiterHandler delHandler, ValueTransformer valueTransformer)
Creates a new instance ofPropertiesWriter
.- Parameters:
writer
- a Writer object providing the underlying streamdelHandler
- the delimiter handler for dealing with properties with multiple valuesvalueTransformer
- the value transformer used to escape property values
-
-
Method Detail
-
escapeKey
protected java.lang.String escapeKey(java.lang.String key)
Escapes the key of a property before it gets written to file. This method is called on saving a configuration for each property key. It ensures that separator characters contained in the key are escaped.- Parameters:
key
- the key- Returns:
- the escaped key
- Since:
- 2.0
-
fetchSeparator
protected java.lang.String fetchSeparator(java.lang.String key, java.lang.Object value)
Returns the separator to be used for the given property. This method is called bywriteProperty()
. The string returned here is used as separator between the property key and its value. Per default the method checks whether a global separator is set. If this is the case, it is returned. Otherwise the separator returned bygetCurrentSeparator()
is used, which was set by the associated layout object. Derived classes may implement a different strategy for defining the separator.- Parameters:
key
- the property keyvalue
- the value- Returns:
- the separator to be used
- Since:
- 1.7
-
getCurrentSeparator
public java.lang.String getCurrentSeparator()
Returns the current property separator.- Returns:
- the current property separator
- Since:
- 1.7
-
getDelimiterHandler
public ListDelimiterHandler getDelimiterHandler()
Returns the delimiter handler for properties with multiple values. This object is used to escape property values so that they can be read in correctly the next time they are loaded.- Returns:
- the delimiter handler for properties with multiple values
- Since:
- 2.0
-
getGlobalSeparator
public java.lang.String getGlobalSeparator()
Returns the global property separator.- Returns:
- the global property separator
- Since:
- 1.7
-
getLineSeparator
public java.lang.String getLineSeparator()
Returns the line separator.- Returns:
- the line separator
- Since:
- 1.7
-
setCurrentSeparator
public void setCurrentSeparator(java.lang.String currentSeparator)
Sets the current property separator. This separator is used when writing the next property.- Parameters:
currentSeparator
- the current property separator- Since:
- 1.7
-
setGlobalSeparator
public void setGlobalSeparator(java.lang.String globalSeparator)
Sets the global property separator. This separator corresponds to theglobalSeparator
property ofPropertiesConfigurationLayout
. It defines the separator to be used for all properties. If it is undefined, the current separator is used.- Parameters:
globalSeparator
- the global property separator- Since:
- 1.7
-
setLineSeparator
public void setLineSeparator(java.lang.String lineSeparator)
Sets the line separator. Each line written by this writer is terminated with this separator. If not set, the platform-specific line separator is used.- Parameters:
lineSeparator
- the line separator to be used- Since:
- 1.7
-
writeComment
public void writeComment(java.lang.String comment) throws java.io.IOException
Write a comment.- Parameters:
comment
- the comment to write- Throws:
java.io.IOException
- if an I/O error occurs.
-
writeln
public void writeln(java.lang.String s) throws java.io.IOException
Helper method for writing a line with the platform specific line ending.- Parameters:
s
- the content of the line (may be null)- Throws:
java.io.IOException
- if an error occurs- Since:
- 1.3
-
writeProperty
public void writeProperty(java.lang.String key, java.util.List<?> values) throws java.io.IOException
Write a property.- Parameters:
key
- The key of the propertyvalues
- The array of values of the property- Throws:
java.io.IOException
- if an I/O error occurs.
-
writeProperty
public void writeProperty(java.lang.String key, java.lang.Object value) throws java.io.IOException
Write a property.- Parameters:
key
- the key of the propertyvalue
- the value of the property- Throws:
java.io.IOException
- if an I/O error occurs.
-
writeProperty
public void writeProperty(java.lang.String key, java.lang.Object value, boolean forceSingleLine) throws java.io.IOException
Writes the given property and its value. If the value happens to be a list, theforceSingleLine
flag is evaluated. If it is set, all values are written on a single line using the list delimiter as separator.- Parameters:
key
- the property keyvalue
- the property valueforceSingleLine
- the "force single line" flag- Throws:
java.io.IOException
- if an error occurs- Since:
- 1.3
-
-