Copyright (C) 2014 Andrei Olaru under the GNU General Public License. See http://www.gnu.org/licenses/.
B C E L M N S T 

B

build() - Method in class net.xqhs.util.config.Config
 
build() - Method in interface net.xqhs.util.config.Configurable
This method should always be an alias of lock().

C

Config - Class in net.xqhs.util.config
The Config is to be used as a base class / paradigm for any construction-time configuration that needs a large number of parameters and considers optional and default parameters.
Config() - Constructor for class net.xqhs.util.config.Config
Default constructor, that calls the Config.makeDefaults() method.
Config.ConfigLockedException - Exception in net.xqhs.util.config
Exception that is thrown when a 'locked' setter is called on a locked Config instance.
Config.ConfigLockedException() - Constructor for exception net.xqhs.util.config.Config.ConfigLockedException
 
Configurable - Interface in net.xqhs.util.config
The Configurable interface is meant to be used as an interface / paradigm for any class that separates construction-time configuration methods from the rest of the instance's lifecycle.

E

ensureLocked() - Method in class net.xqhs.util.config.Config
 
ensureLocked() - Method in interface net.xqhs.util.config.Configurable
This method should check the locking status and call lock() only once in the lifetime of the instance.

L

lock() - Method in class net.xqhs.util.config.Config
 
lock() - Method in interface net.xqhs.util.config.Configurable
'Locks' the configuration, meaning that construction time is over.
locked - Variable in class net.xqhs.util.config.Config
Retains the 'locked' state of the Config instance.
locked() - Method in class net.xqhs.util.config.Config
 
locked() - Method in interface net.xqhs.util.config.Configurable
Should be called at the entry point of methods that should not be called after the instance has been 'locked'.
lockedEx() - Method in class net.xqhs.util.config.Config
Alias of Config.locked() that cannot be overridden, meaning that a call to this method is sure to do what the implementation in Config specifies, so that extending classes cannot avoid the exception by overriding Config.locked().

M

makeDefaults() - Method in class net.xqhs.util.config.Config
 
makeDefaults() - Method in interface net.xqhs.util.config.Configurable
Initializes all optional parameters to their default value.

N

net.xqhs.util.config - package net.xqhs.util.config
This package contains the Config abstract class.

S

serialVersionUID - Static variable in exception net.xqhs.util.config.Config.ConfigLockedException
The serial UID.

T

toString() - Method in exception net.xqhs.util.config.Config.ConfigLockedException
 
B C E L M N S T 
Copyright (C) 2014 Andrei Olaru under the GNU General Public License. See http://www.gnu.org/licenses/.