org.refcodes.collection

Interface Properties

All Superinterfaces:

Containable, Dictionary<String,String>, Keys<String,String>

All Known Subinterfaces:

Properties.ClearableProperties, Properties.MutableProperties, Properties.PropertiesBuilder

All Known Implementing Classes:

PropertiesImpl, PropertiesImpl.MutablePropertiesImpl, PropertiesImpl.PropertiesBuilderImpl

public interface Properties
extends Dictionary<String,String>

The Properties are a specialization of the Dictionary. As the name says its on a String pairs key/value collection as properties usually occur in pure text form to be converted to the required data types. For this reason, the Properties interface provides additional conversion methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Properties.ClearableProperties
static interface	Properties.MutableProperties
static interface	Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.collection.Dictionary

Dictionary.ClearableDictionary<K,V>, Dictionary.MutableDictionary<K,V>

Nested classes/interfaces inherited from interface org.refcodes.collection.Keys

Keys.ClearableKeys<K,V>, Keys.MutableKeys<K,V>

Method Summary

Modifier and Type	Method and Description
default Boolean	getBoolean(String aKey) Returns the Boolean value of the property referred to by the key.
default Byte	getByte(String aKey) Returns the Byte value of the property referred to by the key.
default Double	getDouble(String aKey) Returns the Double value of the property referred to by the key.
default Float	getFloat(String aKey) Returns the Float value of the property referred to by the key.
default Integer	getInteger(String aKey) Returns the Integer value of the property referred to by the key.
default Long	getLong(String aKey) Returns the Long value of the property referred to by the key.
default Short	getShort(String aKey) Returns the Short value of the property referred to by the key.
default void	saveTo(File aFile) Saves the properties to the given file.
default void	saveTo(File aFile, String aComment) Saves the properties to the given file.
default void	saveTo(String aFilePath) Saves the properties to the given file.
default void	saveTo(String aFilePath, String aComment) Saves the properties to the given file.
default Map<String,String>	toMap() This method creates a Map instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
default Properties	toProperties() This method creates a Properties instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.

Methods inherited from interface org.refcodes.collection.Keys

containsKey, get, keySet, values

Methods inherited from interface org.refcodes.collection.Containable

isEmpty, size

Method Detail

getInteger

default Integer getInteger(String aKey)
                    throws NumberFormatException

Returns the Integer value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Integer representation of the key's String value.

Throws:

NumberFormatException - thrown in case conversion fails.

getShort

default Short getShort(String aKey)
                throws NumberFormatException

Returns the Short value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Short representation of the key's String value.

Throws:

NumberFormatException - thrown in case conversion fails.

getByte

default Byte getByte(String aKey)
              throws NumberFormatException

Returns the Byte value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Byte representation of the key's String value.

Throws:

NumberFormatException - thrown in case conversion fails.

getDouble

default Double getDouble(String aKey)
                  throws NumberFormatException

Returns the Double value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Double representation of the key's String value.

Throws:

NumberFormatException - thrown in case conversion fails.

getFloat

default Float getFloat(String aKey)
                throws NumberFormatException

Returns the Float value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Float representation of the key's String value.

Throws:

NumberFormatException - thrown in case conversion fails.

getBoolean

default Boolean getBoolean(String aKey)
                    throws NumberFormatException

Returns the Boolean value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Boolean representation of the key's String value.

Throws:

NumberFormatException - thrown in case conversion fails.

getLong

default Long getLong(String aKey)
              throws NumberFormatException

Returns the Long value of the property referred to by the key. As property keys and values are of type String, the String value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

Returns:

The Long representation of the key's String value.

Throws:

NumberFormatException - thrown in case conversion fails.

toProperties

default Properties toProperties()

This method creates a Properties instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.

Returns:

A Properties object from the herein contained key/value-pairs .

toMap

default Map<String,String> toMap()

This method creates a Map instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.

Returns:

A Map object from the herein contained key/value-pairs .

saveTo

default void saveTo(String aFilePath)
             throws IOException

Saves the properties to the given file. Load them via Properties.MutableProperties.loadFrom(File)

Parameters:

aFilePath - The file path from which to load the properties.

Throws:

IOException - thrown in case saving the properties failed

saveTo

default void saveTo(File aFile)
             throws IOException

Saves the properties to the given file. Load them via Properties.MutableProperties.loadFrom(File)

Parameters:

aFile - The File from which to load the properties.

Throws:

IOException - thrown in case saving the properties failed

saveTo

default void saveTo(String aFilePath,
                    String aComment)
             throws IOException

Saves the properties to the given file. Load them via Properties.MutableProperties.loadFrom(File)

Parameters:

aFilePath - The file path from which to load the properties.

aComment - The description for the properties file.

Throws:

IOException - thrown in case saving the properties failed

saveTo

default void saveTo(File aFile,
                    String aComment)
             throws IOException

Saves the properties to the given file. Load them via Properties.MutableProperties.loadFrom(File)

Parameters:

aFile - The File from which to load the properties.

aComment - The description for the properties file.

Throws:

IOException - thrown in case saving the properties failed