pw.aru.utils

Class Properties

java.lang.Object

java.util.AbstractMap<K,V>

java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String>

pw.aru.utils.Properties

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>, java.util.Map<java.lang.String,java.lang.String>

public class Properties
extends java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String>

Clean version of Properties, using new stuff like HashMaps and Generics. Compatible with files generated by the the original Properties class.

Author:

Arthur van Hoff, Michael McCloskey, Xueming Shen, AdrianTodt

See Also:

Properties, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

java.util.concurrent.ConcurrentHashMap.KeySetView<K,V>

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Properties()

Method Summary

Modifier and Type	Method and Description
static Properties	fromFile(java.io.File file) Loads the Properties from the file system.
static Properties	fromFile(java.lang.String file) Loads the Properties from the file system.
static Properties	fromString(java.lang.String string) Loads the Properties from a string.
void	load(java.io.InputStream inStream) Loads values from the InputStream.
void	load(java.io.Reader reader) Loads values from the Reader.
void	loadFromString(java.lang.String string) Loads values from a String.
void	store(java.io.File file, java.lang.String comments) Stores values into a File.
void	store(java.io.OutputStream out, java.lang.String comments) Stores values into a OutputStream.
void	store(java.io.Writer writer, java.lang.String comments) Stores values into a Writer.
java.lang.String	storeToString(java.lang.String comments) Stores values into a String.

Methods inherited from class java.util.concurrent.ConcurrentHashMap

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, get, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, put, putAll, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Properties

public Properties()

Method Detail

fromFile

@NotNull
public static Properties fromFile(@NotNull
                                            java.io.File file)
                                     throws java.io.IOException

Loads the Properties from the file system.

Parameters:

file - File to read properties from.

Returns:

A Properties instance loaded with the content from the file.

Throws:

java.io.IOException - if an IOException occurs.

fromFile

@NotNull
public static Properties fromFile(@NotNull
                                            java.lang.String file)
                                     throws java.io.IOException

Loads the Properties from the file system.

Parameters:

file - File to read properties from.

Returns:

A new Properties instance loaded with the content from the file.

Throws:

java.io.IOException - if an IOException occurs.

fromString

@NotNull
public static Properties fromString(@NotNull
                                              java.lang.String string)
                                       throws java.io.IOException

Loads the Properties from a string.

Parameters:

string - String to read properties from.

Returns:

A Properties instance loaded with the content from the string.

Throws:

java.io.IOException - if an IOException occurs.

load

public void load(@NotNull
                 java.io.Reader reader)
          throws java.io.IOException

Loads values from the Reader.

Parameters:

reader - Reader to read the values from.

Throws:

java.io.IOException - if an IOException occurs.

load

public void load(@NotNull
                 java.io.InputStream inStream)
          throws java.io.IOException

Loads values from the InputStream.

Parameters:

inStream - InputStream to read the values from.

Throws:

java.io.IOException - if an IOException occurs.

loadFromString

public void loadFromString(@NotNull
                           java.lang.String string)
                    throws java.io.IOException

Loads values from a String.

Parameters:

string - Reader to read the values from.

Throws:

java.io.IOException - if an IOException occurs.

store

public void store(@NotNull
                  java.io.OutputStream out,
                  @Nullable
                  java.lang.String comments)
           throws java.io.IOException

Stores values into a OutputStream.

Parameters:

out - OutputStream to write the values to.

comments - (Optional) Comments written on the beginning of the OutputStream.

Throws:

java.io.IOException - if an IOException occurs.

store

public void store(@NotNull
                  java.io.Writer writer,
                  @Nullable
                  java.lang.String comments)
           throws java.io.IOException

Stores values into a Writer.

Parameters:

writer - Writer to write the values to.

comments - (Optional) Comments written on the beginning of the Writer.

Throws:

java.io.IOException - if an IOException occurs.

store

public void store(@NotNull
                  java.io.File file,
                  @Nullable
                  java.lang.String comments)
           throws java.io.IOException

Stores values into a File.

Parameters:

file - File to write the values to.

comments - (Optional) Comments written on the beginning of the File.

Throws:

java.io.IOException - if an IOException occurs.

storeToString

@NotNull
public java.lang.String storeToString(@Nullable
                                                java.lang.String comments)
                                         throws java.io.IOException

Stores values into a String.

Parameters:

comments - (Optional) Comments written on the beginning of the File.

Returns:

The values written to a String.

Throws:

java.io.IOException - if an IOException occurs.