dk.heick.properties.collections

Class PropertyCollectionPrinter

java.lang.Object

dk.heick.properties.collections.PropertyCollectionPrinter

public class PropertyCollectionPrinter
extends Object

This class can "print" an PropertyCollection. This is a tool class where you as a developer take a PropertyCollection instance and it will
print the property.name = default.value to a Writer or a PrintStream.
This can be used for generation initial properties files for further modification


For a property with a not null but valid default value the resulting line is:

  property.name = getDefaultValueAsString() 

For a property with a not null but invalid default value the resulting line is:

  property.name = Default value invalid:exception.message

For a property with a null as default value the resulting line is:

  property.name = [NULL]

Since:

1.0

Version:

1.0

Author:

Frederik Heick

See Also:

PropertyCollection, Writer, PrintStream, PropertyType.getDefaultValueAsString()

Method Summary

Modifier and Type	Method and Description
static void	generatePropertyFileContents(PropertyCollection collection) Will write the IPropertyCollection to the PrintStream System.out.
static void	generatePropertyFileContents(PropertyCollection collection, File file) Will write the IPropertyCollection to a file.
static void	generatePropertyFileContents(PropertyCollection collection, PrintStream printStream) Will write the IPropertyCollection to a java.io.PrintStream.
static void	generatePropertyFileContents(PropertyCollection collection, Writer writer) Will write the IPropertyCollection to a java.io.Writer.

Methods inherited from class java.lang.Object

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

Method Detail

generatePropertyFileContents

public static void generatePropertyFileContents(PropertyCollection collection,
                                                File file)
                                         throws IOException

Will write the IPropertyCollection to a file. See class description.
This will flush and close the fileWriter in the finally section.

Parameters:

collection - the IPropertyCollection to print

file - the file to write to, this will be created/overwritten.

Throws:

IOException - for any IOException

See Also:

FileWriter, IOException, PropertyCollection, File

generatePropertyFileContents

public static void generatePropertyFileContents(PropertyCollection collection,
                                                Writer writer)
                                         throws IOException

Will write the IPropertyCollection to a java.io.Writer. See class description.
It is the developers responsibility to flush and/or close the Writer.

Parameters:

collection - the IPropertyCollection to print.

writer - the Writer to write to.

Throws:

IOException - for any IOException

See Also:

Writer, IOException, PropertyCollection

generatePropertyFileContents

public static void generatePropertyFileContents(PropertyCollection collection,
                                                PrintStream printStream)

Will write the IPropertyCollection to a java.io.PrintStream. See class description.
This will flush and close the PrintStream in the finally section. This is mainly made for convenience to use the "System.out".

Parameters:

collection - the IPropertyCollection to print

printStream - the PrintStream to write to.

See Also:

PrintStream, PropertyCollection

generatePropertyFileContents

public static void generatePropertyFileContents(PropertyCollection collection)

Will write the IPropertyCollection to the PrintStream System.out. See class description.

Parameters:

collection - the IPropertyCollection to print