org.pfsw.file

Class PropertiesFileWriter

java.lang.Object

org.pfsw.file.PropertiesFileWriter

public class PropertiesFileWriter
extends java.lang.Object

Writes ordered properties with preserved comments and blank lines to a file.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	NEWLINE

Constructor Summary

Constructors

Constructor and Description
PropertiesFileWriter() Initialize the new instance with default values.

Method Summary

Modifier and Type	Method and Description
protected FileUtil	fileUtil()
void	writeTo(java.io.File file, PropertiesFileContent properties) Writes the given properties including all comments and blank lines to the specified file.
void	writeTo(java.lang.String filename, PropertiesFileContent properties) Writes the given properties including all comments and blank lines to a file with the specified name.
void	writeTo(java.io.Writer writer, PropertiesFileContent properties) Writes the given properties including all comments and blank lines to the given writer.

Methods inherited from class java.lang.Object

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

Field Detail

NEWLINE

protected static final java.lang.String NEWLINE

Constructor Detail

PropertiesFileWriter

public PropertiesFileWriter()

Initialize the new instance with default values.

Method Detail

writeTo

public void writeTo(java.lang.String filename,
                    PropertiesFileContent properties)
             throws java.io.IOException

Writes the given properties including all comments and blank lines to a file with the specified name.

Parameters:

filename - The name of the file to write to (must not be null).

properties - The properties to write (must not be null).

Throws:

java.io.IOException

writeTo

public void writeTo(java.io.File file,
                    PropertiesFileContent properties)
             throws java.io.IOException

Writes the given properties including all comments and blank lines to the specified file.

Parameters:

file - The file to write to (must not be null).

properties - The properties to write (must not be null).

Throws:

java.io.IOException

writeTo

public void writeTo(java.io.Writer writer,
                    PropertiesFileContent properties)
             throws java.io.IOException

Writes the given properties including all comments and blank lines to the given writer. When the method is finished the writer is closed. That is also true if an exception was thrown.

Parameters:

writer - The writer object to write the properties to (must not be null).

properties - The properties to write (must not be null).

Throws:

java.io.IOException

fileUtil

protected FileUtil fileUtil()