Constructor Detail

• PropertiesConfiguration.PropertiesWriter

  public PropertiesConfiguration.PropertiesWriter(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 String getCurrentSeparator()

  Returns the current property separator.

  Returns:

  the current property separator

  Since:

  1.7

• setCurrentSeparator

  public void setCurrentSeparator(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 String getGlobalSeparator()

  Returns the global property separator.

  Returns:

  the global property separator

  Since:

  1.7

• setGlobalSeparator

  public void setGlobalSeparator(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 String getLineSeparator()

  Returns the line separator.

  Returns:

  the line separator

  Since:

  1.7

• setLineSeparator

  public void setLineSeparator(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(String key,
                   Object value)
                     throws IOException

  Write a property.

  Parameters:

  key - the key of the property

  value - the value of the property

  Throws:

  IOException - if an I/O error occurs

• writeProperty

  public void writeProperty(String key,
                   List<?> values)
                     throws IOException

  Write a property.

  Parameters:

  key - The key of the property

  values - The array of values of the property

  Throws:

  IOException - if an I/O error occurs

• writeProperty

  public void writeProperty(String key,
                   Object value,
                   boolean forceSingleLine)
                     throws 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:

  IOException - if an error occurs

  Since:

  1.3

• writeComment

  public void writeComment(String comment)
                    throws IOException

  Write a comment.

  Parameters:

  comment - the comment to write

  Throws:

  IOException - if an I/O error occurs

• writeln

  public void writeln(String s)
               throws IOException

  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

  protected String fetchSeparator(String key,
                      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