asia.redact.bracket.properties.io

Class OutputAdapter

java.lang.Object

asia.redact.bracket.properties.io.OutputAdapter

public class OutputAdapter
extends Object

Output the properties to various data sinks and in various charsets and formats.

Author:

Dave

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Properties	props

Constructor Summary

Constructors

Constructor and Description
OutputAdapter(Properties properties)

Method Summary

Modifier and Type	Method and Description
static String	toJSON(Properties props) Simple JSON formatting, emits the properties as an ordered, flattened JSON object.
static String	toJSON(Properties props, WriterConfig config) Simple JSON formatting, emits the properties as an ordered, flattened JSON object where you control the output format.
static String	toString(Properties props) Write properties in a default manner to a String.
static String	toXML(Properties props) Write out a legacy Sun DTD-compatible XML-formatted string representation of the properties.
void	writeAsciiTo(File file) This is specifically intended for compatibility with java.util.Properties, which outputs in ISO-8859-1 (US-ASCII)
void	writeAsciiTo(File file, OutputFormat format) This method is specifically intended for compatibility with java.util.Properties, which outputs in ISO-8859-1 (US-ASCII)
void	writeAsciiTo(Writer writer) This is specifically intended for compatibility with java.util.Properties, which outputs in ISO-8859-1 (US-ASCII) with escapes
void	writeTo(File file, Charset charset) Write to a file using a PlainOutputFormat.
void	writeTo(File file, OutputFormat format, Charset charset) Use to control the format of the output to a file.
void	writeTo(OutputStream out, OutputFormat format, Charset charset) Use to control the format of the output to a stream.
void	writeTo(Writer writer) Same as above but with a PlainOutputFormat
void	writeTo(Writer writer, OutputFormat format)

Methods inherited from class java.lang.Object

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

Field Detail

props

final Properties props

Constructor Detail

OutputAdapter

public OutputAdapter(Properties properties)

Method Detail

writeTo

public void writeTo(OutputStream out,
                    OutputFormat format,
                    Charset charset)

Use to control the format of the output to a stream.

writeTo

public void writeTo(File file,
                    OutputFormat format,
                    Charset charset)

Use to control the format of the output to a file.

writeTo

public void writeTo(File file,
                    Charset charset)

Write to a file using a PlainOutputFormat. If the charset is ISO-8859-1 or US-ASCII, this will call writeAsciiTo(file, charset) which triggers unicode escapes to be written. If the charset is UTF-8 or something else, no unicode escapes will be generated

Parameters:

file -

charset -

writeAsciiTo

public void writeAsciiTo(File file,
                         OutputFormat format)

This method is specifically intended for compatibility with java.util.Properties, which outputs in ISO-8859-1 (US-ASCII)

Use AsciiOutputFormat to get unicode escapes or an output format with similar filtering, as escapes are required for compatibility.

writeAsciiTo

public void writeAsciiTo(File file)

This is specifically intended for compatibility with java.util.Properties, which outputs in ISO-8859-1 (US-ASCII)

writeAsciiTo

public void writeAsciiTo(Writer writer)

This is specifically intended for compatibility with java.util.Properties, which outputs in ISO-8859-1 (US-ASCII) with escapes

writeTo

public void writeTo(Writer writer,
                    OutputFormat format)
             throws IOException

Throws:

IOException

writeTo

public void writeTo(Writer writer)
             throws IOException

Same as above but with a PlainOutputFormat

Parameters:

writer -

Throws:

IOException

toString

public static final String toString(Properties props)

Write properties in a default manner to a String. No unicode escapes are performed here

Parameters:

props -

Returns:

toXML

public static final String toXML(Properties props)

Write out a legacy Sun DTD-compatible XML-formatted string representation of the properties. The comments are not retained. This improves on the legacy Properties class only in that order is retained and CDATA is applied on values when required

Parameters:

props -

Returns:

toJSON

public static final String toJSON(Properties props)

Simple JSON formatting, emits the properties as an ordered, flattened JSON object. The output is pretty-printed

Parameters:

props -

Returns:

toJSON

public static final String toJSON(Properties props,
                                  WriterConfig config)

Simple JSON formatting, emits the properties as an ordered, flattened JSON object where you control the output format. Currently there are only two options.

Parameters:

props -

WriterConfig - can be either WriterConfig.PRETTY_PRINT or WriterConfig.MINIMAL.

Returns: