org.digitalmediaserver.crowdin.tool

Class OrderedProperties

java.lang.Object

org.digitalmediaserver.crowdin.tool.OrderedProperties

All Implemented Interfaces:

Serializable, Iterable<Map.Entry<String,String>>

Direct Known Subclasses:

FIFOProperties, GroupSortedProperties

public abstract class OrderedProperties
extends Object
implements Iterable<Map.Entry<String,String>>, Serializable

An abstract class for ordered key/value pairs behaving very similar to Properties except that the keys have a defined order.

Author:

Nadahar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OrderedProperties.LineReader Reads in a "logical line" from an InputStream or Reader, skips all comment and blank lines and filters out leading whitespace characters from the beginning of a "natural line".

Constructor Summary

Constructors

Constructor and Description
OrderedProperties()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doLoad(OrderedProperties.LineReader lineReader) Reads the data from the specified OrderedProperties.LineReader into this OrderedProperties instance.
void	load(BufferedReader reader) Reads the data from the specified BufferedReader into this OrderedProperties instance.
void	load(InputStream inputStream) Reads the data from the specified InputStream into this OrderedProperties instance.
protected static String	loadConvert(char[] in, int off, int len, char[] convertBuffer) Converts encoded "\uxxxx" to Unicode chars and changes special saved chars to their original form.
abstract String	put(String key, String value) Associates the specified value with the specified key.
protected static String	saveConvert(String content, boolean isKey, boolean escapeUnicode) Converts Unicode characters to encoded "\uxxxx" and escapes special characters with a preceding "\".
void	store(BufferedWriter bw, String comment, String lineSeparator, boolean escapeUnicode) Writes the data from this OrderedProperties to the specified BufferedWriter.
void	store(OutputStream out, String comment, String lineSeparator, boolean escapeUnicode) Writes the data from this OrderedProperties to the specified OutputStream.
void	store(Writer writer, String comment, String lineSeparator, boolean escapeUnicode) Writes the data from this OrderedProperties to the specified Writer.
static char	toHex(int nibble) Converts a nibble to a hexadecimal digit.
protected static void	writeComment(BufferedWriter bw, String comment, String lineSeparator) Writes a comment line to the specified BufferedWriter.
static void	writeNewLine(BufferedWriter bw, String lineSeparator) Writes a newline to the specified BufferedWriter using the specified line separator sequence.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

OrderedProperties

public OrderedProperties()

Method Detail

put

public abstract String put(String key,
         String value)

Associates the specified value with the specified key. If there previously was a mapping for the key, the old value is replaced.

Parameters:

key - the key with which the specified value is to be associated

value - value to be associated with the specified key.

Returns:

The previous value associated with key, or null if there was no mapping for key or the previously associated value was null.

store

public void store(@Nonnull
         OutputStream out,
         @Nullable
         String comment,
         @Nullable
         String lineSeparator,
         boolean escapeUnicode)
           throws IOException

Writes the data from this OrderedProperties to the specified OutputStream.

Parameters:

out - the OutputStream to write to.

comment - the comment to add to the start of the output, or null if no comment should be added.

lineSeparator - the line separator sequence to write.

escapeUnicode - true if Unicode characters should be written using the "\uxxxx" notation, false otherwise.

Throws:

IOException - If an error occurs during the operation.

store

public void store(@Nonnull
         Writer writer,
         @Nullable
         String comment,
         @Nullable
         String lineSeparator,
         boolean escapeUnicode)
           throws IOException

Writes the data from this OrderedProperties to the specified Writer.

Parameters:

writer - the Writer to write to.

comment - the comment to add to the start of the output, or null if no comment should be added.

lineSeparator - the line separator sequence to write.

escapeUnicode - true if Unicode characters should be written using the "\uxxxx" notation, false otherwise.

Throws:

IOException - If an error occurs during the operation.

store

public void store(@Nonnull
         BufferedWriter bw,
         @Nullable
         String comment,
         @Nullable
         String lineSeparator,
         boolean escapeUnicode)
           throws IOException

Writes the data from this OrderedProperties to the specified BufferedWriter.

Parameters:

bw - the BufferedWriter to write to.

comment - the comment to add to the start of the output, or null if no comment should be added.

lineSeparator - the line separator sequence to write.

escapeUnicode - true if Unicode characters should be written using the "\uxxxx" notation, false otherwise.

Throws:

IOException - If an error occurs during the operation.

writeNewLine

public static void writeNewLine(@Nonnull
                BufferedWriter bw,
                @Nullable
                String lineSeparator)
                         throws IOException

Writes a newline to the specified BufferedWriter using the specified line separator sequence.

Parameters:

bw - the BufferedWriter to write to.

lineSeparator - the line separator sequence to write.

Throws:

IOException - If an error occurs during the operation.

load

public void load(@Nullable
        InputStream inputStream)
          throws IOException

Reads the data from the specified InputStream into this OrderedProperties instance.

Parameters:

inputStream - the InputStream to read from.

Throws:

IOException - If an error occurs during the operation.

load

public void load(@Nullable
        BufferedReader reader)
          throws IOException

Reads the data from the specified BufferedReader into this OrderedProperties instance.

Parameters:

reader - the BufferedReader to read from.

Throws:

IOException - If an error occurs during the operation.

doLoad

protected void doLoad(@Nonnull
          OrderedProperties.LineReader lineReader)
               throws IOException

Reads the data from the specified OrderedProperties.LineReader into this OrderedProperties instance.

Parameters:

lineReader - the OrderedProperties.LineReader to use.

Throws:

IOException - If an error occurs during the operation.

loadConvert

protected static String loadConvert(@Nonnull
                 char[] in,
                 int off,
                 int len,
                 @Nonnull
                 char[] convertBuffer)

Converts encoded "\uxxxx" to Unicode chars and changes special saved chars to their original form.

Parameters:

in - the char array to convert.

off - the offset to use.

len - the length to read.

convertBuffer - the conversion buffer to (re-)use.

Returns:

The converted String.

saveConvert

@Nullable
protected static String saveConvert(@Nullable
                          String content,
                          boolean isKey,
                          boolean escapeUnicode)

Converts Unicode characters to encoded "\uxxxx" and escapes special characters with a preceding "\".

Changes from Properties.saveConvert(java.lang.String, boolean, boolean) are that =, :, # and ! are only escaped in keys, and that a StringBuilder is used instead of a StringBuffer since there's no need for the added cost of synchronization.

Parameters:

content - the String to convert.

isKey - true if the String should be converted as a key, false otherwise.

escapeUnicode - true if the String should have Unicode characters converted to "\uxxxx" notation, false otherwise.

Returns:

The converted String.

writeComment

protected static void writeComment(@Nonnull
                BufferedWriter bw,
                @Nullable
                String comment,
                @Nullable
                String lineSeparator)
                            throws IOException

Writes a comment line to the specified BufferedWriter.

Changes from Properties.writeComments(java.io.BufferedWriter, java.lang.String) are that a space is added between the comment tag and the comment itself and that no date is added.

Parameters:

bw - the BufferedWriter to write to.

comment - the comment String.

lineSeparator - the line separator sequence to use.

Throws:

IOException - If an error occurs during the operation.

toHex

public static char toHex(int nibble)

Converts a nibble to a hexadecimal digit.

Parameters:

nibble - the nibble to convert.

Returns:

The hexadecimal digit.

Throws:

ArrayIndexOutOfBoundsException - If nibble isn't in the range 0 to 16.