me.timothy.bots

Class FileConfiguration

java.lang.Object

me.timothy.bots.FileConfiguration

public class FileConfiguration
extends java.lang.Object

Loads lots and lots of various strings/properties from there appropriate files.

Author:

Timothy

Constructor Summary

Constructors

Constructor and Description
FileConfiguration() Initializes a file configuration but does not load any configuration.

Method Summary

Modifier and Type	Method and Description
void	addList(java.lang.String name, boolean required) Adds a list to the map where the file is in the current directory and the files name is name appended with .txt
void	addProperties(java.lang.String name, boolean required, java.lang.String... requiredKeys) Adds a property to the map where the file is in the current directory and the files name is name appended with .properties
void	addString(java.lang.String name, boolean required) Adds a string to the map where the file is in the current directory and the files name is name appended with .txt
java.nio.file.Path	getFolder() Gets the absolute path of the folder that configuration is being loaded from
java.util.List<java.lang.String>	getList(java.lang.String name)
java.util.Map<java.lang.String,java.util.Properties>	getProperties() Get the map of strings -> properties
java.lang.String	getProperty(java.lang.String key) Gets the property where the part before the .
java.lang.String	getString(java.lang.String name)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getStringLists() Get the map for strings -> string lists
java.util.Map<java.lang.String,java.lang.String>	getStrings() Get the map for strings -> strings
void	load() Loads all the necessary configuration.
protected java.util.Properties	loadProperties(java.nio.file.Path path, java.lang.String... requiredKeys) Loads properties from the specified file, as if by Properties.load(java.io.Reader)
protected java.lang.String	loadReplyString(java.nio.file.Path path) Loads a reply string from a file, ignoring lines prefixed with a hash-tag (#).
protected java.util.List<java.lang.String>	loadStringList(java.nio.file.Path path) Loads a list of strings from the file, where there is 1 string per line.
void	setFolder(java.nio.file.Path path) Sets the path to the folder that configuration is being loaded from.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileConfiguration

public FileConfiguration()

Initializes a file configuration but does not load any configuration.

Method Detail

load

public void load()
          throws java.io.IOException,
                 java.lang.NullPointerException

Loads all the necessary configuration.

Throws:

java.io.IOException - if an io-exception occurs (or a file is not found)

java.lang.NullPointerException - if a required key is missing

getFolder

public java.nio.file.Path getFolder()

Gets the absolute path of the folder that configuration is being loaded from

Returns:

the folder that configuration is being loaded from

setFolder

public void setFolder(java.nio.file.Path path)

Sets the path to the folder that configuration is being loaded from. Cannot be null and must exist.

Parameters:

path - the folder to load config from

getProperty

public java.lang.String getProperty(java.lang.String key)

Gets the property where the part before the . is the name of the properties and following that is the key in the properties.

E.g.

addProperty("user", true, "username", "password")
.
.
.
getProperty("user.username")

Parameters:

key - the key

Returns:

the property

getList

public java.util.List<java.lang.String> getList(java.lang.String name)

getString

public java.lang.String getString(java.lang.String name)

addProperties

public void addProperties(java.lang.String name,
                          boolean required,
                          java.lang.String... requiredKeys)
                   throws java.lang.NullPointerException,
                          java.io.IOException

Adds a property to the map where the file is in the current directory and the files name is name appended with .properties

Parameters:

name - the name of the file except for .properties

required - if an NPE should be thrown if the file doesn't exist

requiredKeys - the keys that must be in the properties file

Throws:

java.lang.NullPointerException - if the file doesn't exist and it is required, or a key is missing from the properties

java.io.IOException - if an i/o exception occurs

addList

public void addList(java.lang.String name,
                    boolean required)
             throws java.io.IOException

Adds a list to the map where the file is in the current directory and the files name is name appended with .txt

Parameters:

name - the name of the file

required - if an NPE should be thrown if the file doesn't exist

Throws:

java.io.IOException - if an i/o exception occurs

addString

public void addString(java.lang.String name,
                      boolean required)
               throws java.io.IOException

Adds a string to the map where the file is in the current directory and the files name is name appended with .txt

Parameters:

name - the name of the file

required - if an NPE should be thrown if the file doesn't exist

Throws:

java.io.IOException - if an i/o exception occurs

loadProperties

protected java.util.Properties loadProperties(java.nio.file.Path path,
                                              java.lang.String... requiredKeys)
                                       throws java.io.IOException,
                                              java.lang.NullPointerException

Loads properties from the specified file, as if by Properties.load(java.io.Reader)

Parameters:

path - the file to load from

requiredKeys - the list of required keys

Returns:

the properties in the file

Throws:

java.io.IOException - if an i/o exception occurs (like file not existing)

java.lang.NullPointerException - if a required key is missing or the file is null

loadReplyString

protected java.lang.String loadReplyString(java.nio.file.Path path)
                                    throws java.io.IOException

Loads a reply string from a file, ignoring lines prefixed with a hash-tag (#). Any empty lines prior to the first non-empty line are ignored. Lines are separated Unix-like (only \n)

Parameters:

path - the file to load from

Returns:

the reply format

Throws:

java.io.IOException - if an i/o exception occurs, like the file not existing

loadStringList

protected java.util.List<java.lang.String> loadStringList(java.nio.file.Path path)
                                                   throws java.io.IOException

Loads a list of strings from the file, where there is 1 string per line. Lines prefixed with /u/ are modified as if by String.substring(int) with parameter 3. All strings are lower-cased.

Parameters:

path - the file to load from

Returns:

each line in the file

Throws:

java.io.IOException - if an i/o exception occurs, like the file not existing

getStrings

public java.util.Map<java.lang.String,java.lang.String> getStrings()

Get the map for strings -> strings

Returns:

the strings

getStringLists

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getStringLists()

Get the map for strings -> string lists

Returns:

the lists

getProperties

public java.util.Map<java.lang.String,java.util.Properties> getProperties()

Get the map of strings -> properties

Returns:

the properties