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() Removes all the mappings from this map.
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 defaultValue) 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.
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	removeProperty(String key) A method used to remove a property from a properties map.
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	setProperty(String key, Object value, boolean replace) 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

See Also:

setProperty(String, Object, boolean)

setProperty

public void setProperty(String key,
                        Object value,
                        boolean replace)

A method used to set a value to a property inside our property list if it does not already exist. If, the key already exists, you need to specify whether this method should override its current value.

Parameters:

key - The target key.

value - The desired value.

replace - Enable overwriting.

Since:

1.0.0

See Also:

setProperty(String, Object)

removeProperty

public void removeProperty(String key)

A method used to remove a property from a properties map. Keep in mind this property does not save changes by default.

Parameters:

key - Target key

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), setProperty(String, Object, boolean)

getProperty

public String getProperty(String key,
                          Object defaultValue)

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.

defaultValue - A default value.

Returns:

The value in the property list.

Since:

1.0.0

See Also:

setProperty(String, Object), setProperty(String, Object, boolean)

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

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

clear

public void clear()

Removes all the mappings from this map.

Since:

1.0.0