Package org.apache.commons.configuration
Class PropertiesConfiguration.PropertiesWriter
java.lang.Object
java.io.Writer
java.io.FilterWriter
org.apache.commons.configuration.PropertiesConfiguration.PropertiesWriter
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
- Enclosing class:
PropertiesConfiguration
This class is used to write properties lines. The most important method
is
writeProperty(String, Object, boolean)
, which is called
during a save operation for each property found in the configuration.-
Field Summary
Fields inherited from class java.io.FilterWriter
out
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
fetchSeparator
(String key, Object value) Returns the separator to be used for the given property.Returns the current property separator.Returns the global property separator.Returns the line separator.void
setCurrentSeparator
(String currentSeparator) Sets the current property separator.void
setGlobalSeparator
(String globalSeparator) Sets the global property separator.void
setLineSeparator
(String lineSeparator) Sets the line separator.void
writeComment
(String comment) Write a comment.void
Helper method for writing a line with the platform specific line ending.void
writeProperty
(String key, Object value) Write a property.void
writeProperty
(String key, Object value, boolean forceSingleLine) Writes the given property and its value.void
writeProperty
(String key, List<?> values) Write a property.
-
Constructor Details
-
PropertiesWriter
Constructor.- Parameters:
writer
- a Writer object providing the underlying streamdelimiter
- the delimiter character for multi-valued properties
-
-
Method Details
-
getCurrentSeparator
Returns the current property separator.- Returns:
- the current property separator
- Since:
- 1.7
-
setCurrentSeparator
Sets the current property separator. This separator is used when writing the next property.- Parameters:
currentSeparator
- the current property separator- Since:
- 1.7
-
getGlobalSeparator
Returns the global property separator.- Returns:
- the global property separator
- Since:
- 1.7
-
setGlobalSeparator
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
-
getLineSeparator
Returns the line separator.- Returns:
- the line separator
- Since:
- 1.7
-
setLineSeparator
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
-
writeProperty
Write a property.- Parameters:
key
- the key of the propertyvalue
- the value of the property- Throws:
IOException
- if an I/O error occurs
-
writeProperty
Write a property.- Parameters:
key
- The key of the propertyvalues
- The array of values of the property- Throws:
IOException
- if an I/O error occurs
-
writeProperty
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:
IOException
- if an error occurs- Since:
- 1.3
-
writeComment
Write a comment.- Parameters:
comment
- the comment to write- Throws:
IOException
- if an I/O error occurs
-
writeln
Helper method for writing a line with the platform specific line ending.- Parameters:
s
- the content of the line (may be null)- Throws:
IOException
- if an error occurs- Since:
- 1.3
-
fetchSeparator
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
-