Package com.jsql.view.swing.dialog.translate

Class OrderedProperties

java.lang.Object

com.jsql.view.swing.dialog.translate.OrderedProperties

public final class OrderedProperties
extends Object

This class provides an alternative to the JDK's Properties class. It fixes the design flaw of using inheritance over composition, while keeping up the same APIs as the original class. Keys and values are guaranteed to be of type String.

This class is not synchronized, contrary to the original implementation.

As additional functionality, this class keeps its properties in a well-defined order. By default, the order is the one in which the individual properties have been added, either through explicit API calls or through reading them top-to-bottom from a properties file.

Also, an optional flag can be set to omit the comment that contains the current date when storing the properties to a properties file.

Currently, this class does not support the concept of default properties, contrary to the original implementation.

Note that this implementation is not synchronized. If multiple threads access ordered properties concurrently, and at least one of the threads modifies the ordered properties structurally, it must be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the properties.

Note that the actual (and quite complex) logic of parsing and storing properties from and to a stream is delegated to the Properties class from the JDK.

See Also:

• Properties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OrderedProperties.OrderedPropertiesBuilder	Builder for OrderedProperties instances.

Constructor Summary

Constructors

Constructor	Description
OrderedProperties()	Creates a new instance that will keep the properties in the order they have been added.

Method Summary

Modifier and Type	Method	Description
boolean	containsProperty(String key)	Returns true if there is a property with the specified key.
static OrderedProperties	copyOf(OrderedProperties source)	Creates a new instance that will have both the same property entries and the same behavior as the given source.
Set<Map.Entry<String,String>>	entrySet()	See Properties.entrySet().
boolean	equals(Object other)
String	getProperty(String key)	See Properties.getProperty(String).
String	getProperty(String key, String defaultValue)	See Properties.getProperty(String, String).
int	hashCode()
boolean	isEmpty()	See Properties.isEmpty().
void	list(PrintStream stream)	See Properties.list(PrintStream).
void	list(PrintWriter writer)	See Properties.list(PrintWriter).
void	load(InputStream stream)	See Properties.load(InputStream).
void	load(Reader reader)	See Properties.load(Reader).
void	loadFromXML(InputStream stream)	See Properties.loadFromXML(InputStream).
Enumeration<String>	propertyNames()	See Properties.propertyNames().
String	removeProperty(String key)	Removes the property with the specified key, if it is present.
String	setProperty(String key, String value)	See Properties.setProperty(String, String).
int	size()	See Properties.size().
void	store(OutputStream stream, String comments)	See Properties.store(OutputStream, String).
void	store(Writer writer, String comments)	See Properties.store(Writer, String).
void	storeToXML(OutputStream stream, String comment)	See Properties.storeToXML(OutputStream, String).
void	storeToXML(OutputStream stream, String comment, String encoding)	See Properties.storeToXML(OutputStream, String, String).
Set<String>	stringPropertyNames()	See Properties.stringPropertyNames().
Properties	toJdkProperties()	Convert this instance to a Properties instance.
String	toString()	See Properties.toString().

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OrderedProperties

public OrderedProperties()

Creates a new instance that will keep the properties in the order they have been added. Other than the ordering of the keys, this instance behaves like an instance of the Properties class.

Method Details

getProperty

public String getProperty(String key)

See Properties.getProperty(String).

getProperty

public String getProperty(String key,
 String defaultValue)

See Properties.getProperty(String, String).

setProperty

public String setProperty(String key,
 String value)

See Properties.setProperty(String, String).

removeProperty

public String removeProperty(String key)

Removes the property with the specified key, if it is present. Returns the value of the property, or null if there was no property with the specified key.

Parameters:

key - the key of the property to remove

Returns:

the previous value of the property, or null if there was no property with the specified key

containsProperty

public boolean containsProperty(String key)

Returns true if there is a property with the specified key.

Parameters:

key - the key whose presence is to be tested

size

public int size()

See Properties.size().

isEmpty

public boolean isEmpty()

See Properties.isEmpty().

propertyNames

public Enumeration<String> propertyNames()

See Properties.propertyNames().

stringPropertyNames

public Set<String> stringPropertyNames()

See Properties.stringPropertyNames().

entrySet

public Set<Map.Entry<String,String>> entrySet()

See Properties.entrySet().

load

public void load(InputStream stream)
          throws IOException

See Properties.load(InputStream).

Throws:

IOException

load

public void load(Reader reader)
          throws IOException

See Properties.load(Reader).

Throws:

IOException

loadFromXML

public void loadFromXML(InputStream stream)
                 throws IOException

See Properties.loadFromXML(InputStream).

Throws:

IOException

store

public void store(OutputStream stream,
 String comments)
           throws IOException

See Properties.store(OutputStream, String).

Throws:

IOException

store

public void store(Writer writer,
 String comments)
           throws IOException

See Properties.store(Writer, String).

Throws:

IOException

storeToXML

public void storeToXML(OutputStream stream,
 String comment)
                throws IOException

See Properties.storeToXML(OutputStream, String).

Throws:

IOException

storeToXML

public void storeToXML(OutputStream stream,
 String comment,
 String encoding)
                throws IOException

See Properties.storeToXML(OutputStream, String, String).

Throws:

IOException

list

public void list(PrintStream stream)

See Properties.list(PrintStream).

list

public void list(PrintWriter writer)

See Properties.list(PrintWriter).

toJdkProperties

public Properties toJdkProperties()

Convert this instance to a Properties instance.

Returns:

the Properties instance

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

See Properties.toString().

Overrides:

toString in class Object

copyOf

public static OrderedProperties copyOf(OrderedProperties source)

Creates a new instance that will have both the same property entries and the same behavior as the given source.

Note that the source instance and the copy instance will share the same comparator instance if a custom ordering had been configured on the source.

Parameters:

source - the source to copy from

Returns:

the copy