com.frostdeveloper.api.core

Class Properties

java.lang.Object

com.frostdeveloper.api.core.Properties

public class Properties
extends Object

The Properties class is designed to add new methods not seen in the Properties class, makes using properties files much easier and extends Javas properties capabilities.

Since:

1.0.0

Author:

OMGitzFROST

Constructor Summary

Constructors

Constructor and Description
Properties() Creates a new property list with no default values.
Properties(boolean ordered) Creates a new property list with no default values.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this hashtable so that it contains no keys.
boolean	containsKey(Object key) Tests if the specified object is a key in this table.
String	getProperty(String key) A method used to search for a specific property key inside our property list, If the key is not found, this method will return null
String	getProperty(String key, Object def) A method used to search for a specific property key inside our property list, If the key is not found, this method will return the specified default property value.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
boolean	isOrdered() A method used to return whether a properties are to be in alphabetical order.
Enumeration<Object>	keys() Returns an enumeration of the keys in this hashtable.
Set<Object>	keySet() Returns a Set view of the keys contained in this map.
void	load(@NotNull File targetFile) A method used to read a property list (keys and element pairs).
void	load(InputStream inputStream) A method used to read a property list (keys and element pairs).
void	setProperty(String key, Object value) A method used to set a value to a property inside our property list if it does not already exist.
void	store(@NotNull File targetFile) A method used to write our properties list (keys and element pairs), in a format suitable for property loading.
void	store(@NotNull File targetFile, String comment) A method used to write our properties list (keys and element pairs), in a format suitable for property loading.
Set<String>	stringPropertyNames() A method used to return a set of string property names for a property map.

Methods inherited from class java.lang.Object

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

Constructor Detail

Properties

public Properties()

Creates a new property list with no default values.

Since:

1.0.0

Properties

public Properties(boolean ordered)

Creates a new property list with no default values.

Parameters:

ordered - Determines whether the property list should be ordered alphabetically.

Since:

1.0.0

Method Detail

store

public void store(@NotNull
                  @NotNull File targetFile,
                  String comment)

A method used to write our properties list (keys and element pairs), in a format suitable for property loading. This method will include your comment at the top of the file when printing.

Parameters:

targetFile - Storing location.

comment - A description of the property list.

Throws:

ClassCastException - if this Properties object contains any keys or values that are not Strings.

NullPointerException - if out is null.

Since:

1.0.0

See Also:

store(File)

store

public void store(@NotNull
                  @NotNull File targetFile)

A method used to write our properties list (keys and element pairs), in a format suitable for property loading. This method will use Java's default comments when storing to file.

Parameters:

targetFile - Storing location.

Throws:

ClassCastException - if this Properties object contains any keys or values that are not Strings.

NullPointerException - if out is null.

Since:

1.0.0

See Also:

store(File, String)

load

public void load(@NotNull
                 @NotNull File targetFile)

A method used to read a property list (keys and element pairs). The input stream is closed by this method after it returns.

Parameters:

targetFile - File being read.

Throws:

IllegalArgumentException - if the input stream contains a malformed Unicode escape sequence.

NullPointerException - if inStream is null.

Since:

1.0.0

load

public void load(InputStream inputStream)

A method used to read a property list (keys and element pairs). The input stream is closed by this method after it returns.

Parameters:

inputStream - The input stream

Throws:

IllegalArgumentException - if the input stream contains a malformed Unicode escape sequence.

NullPointerException - if inStream is null.

Since:

1.0.0

setProperty

public void setProperty(String key,
                        Object value)

A method used to set a value to a property inside our property list if it does not already exist.

Parameters:

key - The target key.

value - The desired value.

Since:

1.0.0

getProperty

public String getProperty(String key)

A method used to search for a specific property key inside our property list, If the key is not found, this method will return null

Parameters:

key - The target key.

Returns:

The value in the property list.

Since:

1.0.0

See Also:

setProperty(String, Object)

getProperty

public String getProperty(String key,
                          Object def)

A method used to search for a specific property key inside our property list, If the key is not found, this method will return the specified default property value.

Parameters:

key - The target key.

def - A default value.

Returns:

The value in the property list.

Since:

1.0.0

See Also:

setProperty(String, Object)

containsKey

public boolean containsKey(Object key)

Tests if the specified object is a key in this table.

Parameters:

key - possible key

Returns:

true if and only if the specified object is a key in this table, as determined by the equals method; false otherwise

Throws:

NullPointerException - if the specified key is null

Since:

1.0.0

stringPropertyNames

public Set<String> stringPropertyNames()

A method used to return a set of string property names for a property map.

Returns:

Set of string property names

Since:

1.0.0

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Returns:

true if this map contains no key-value mappings

Since:

1.0.0

isOrdered

public boolean isOrdered()

A method used to return whether a properties are to be in alphabetical order.

Returns:

Whether in alphabetical order.

Since:

1.0.0

clear

public void clear()

Clears this hashtable so that it contains no keys.

Since:

1.0.0

keySet

public Set<Object> keySet()

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterators own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Since:

1.3.0

keys

public Enumeration<Object> keys()

Returns an enumeration of the keys in this hashtable.

Returns:

an enumeration of the keys in this hashtable.

Since:

1.3.0

See Also:

Enumeration, keySet(), Map