cl.core.configurable.ConfigurableObject Maven / Gradle / Ivy
Show all versions of cl-core Show documentation
package cl.core.configurable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
/**
* This class is the default implementation of {@link Configurable} interface, which provides common
* infrastructure for all configurable object classes which extend this class.
*
* If a configurable object implementation needs to extend another class and still needs to
* implement {@link Configurable}, the code of this class may serve as an implementation example.
*
* @see Configurable
*/
public abstract class ConfigurableObject> implements Configurable {
private Map, Object> configuration = new HashMap<>();
private boolean locked;
@Override
@SuppressWarnings("unchecked")
public final C with(Key key, T value) {
requireNotLocked();
configuration.put(key, value);
return (C)this;
}
@Override
@SuppressWarnings("unchecked")
public final T get(Key key) {
T value = (T)configuration.get(key);
return value != null ? value : key.getDefaultValue();
}
@Override
public final Set> keys() {
return Collections.unmodifiableSet(configuration.keySet());
}
@Override
@SuppressWarnings("unchecked")
public final C withConfigurationFrom(Configurable other) {
requireNotLocked();
for (Key key : other.keys()) {
configuration.put(key, other.get(key));
}
return (C)this;
}
@Override
@SuppressWarnings("unchecked")
public final C locked() {
if (!locked) {
build();
locked = true;
}
return (C)this;
}
/**
* This method is being called from {@code locked()}. Subclasses may override
* this method in order to provide initialization logic related to configuration before locking it.
* The default implementation does nothing.
*/
protected void build() {}
/**
* Use this method in subclasses to make sure the configuration is locked before an object's method is in use.
*/
protected void requireLock() {
if (!locked) throw new ConfigurableException("configurable object not locked");
}
private void requireNotLocked() {
if (locked) throw new ConfigurableException("configurable object locked");
}
}