Package org.apache.commons.configuration

Class PropertiesConfiguration.PropertiesWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

org.apache.commons.configuration.PropertiesConfiguration.PropertiesWriter

Enclosing class:

PropertiesConfiguration

public static class PropertiesConfiguration.PropertiesWriter
extends java.io.FilterWriter

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

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
PropertiesWriter(java.io.Writer writer, char delimiter)	Constructor.

Method Summary

Modifier and Type	Method	Description
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.
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.

Methods inherited from class java.io.FilterWriter

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from class java.io.Writer

append, append, append, write, write

Constructor Detail

PropertiesWriter

public PropertiesWriter(java.io.Writer writer,
                        char delimiter)

Constructor.

Parameters:

writer - a Writer object providing the underlying stream

delimiter - the delimiter character for multi-valued properties

Method Detail

getCurrentSeparator

public java.lang.String getCurrentSeparator()

Returns the current property separator.

Returns:

the current property 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

getGlobalSeparator

public java.lang.String getGlobalSeparator()

Returns the global property separator.

Returns:

the global property separator

Since:

1.7

setGlobalSeparator

public void setGlobalSeparator(java.lang.String globalSeparator)

Sets the global property separator. This separator corresponds to the globalSeparator property of PropertiesConfigurationLayout. 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

public java.lang.String getLineSeparator()

Returns the line separator.

Returns:

the line 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

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 property

value - the value of the property

Throws:

java.io.IOException - if an I/O error occurs

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 property

values - 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,
                          boolean forceSingleLine)
                   throws java.io.IOException

Writes the given property and its value. If the value happens to be a list, the forceSingleLine 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 key

value - the property value

forceSingleLine - the "force single line" flag

Throws:

java.io.IOException - if an error occurs

Since:

1.3

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

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 by writeProperty(). 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 by getCurrentSeparator() 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 key

value - the value

Returns:

the separator to be used

Since:

1.7