org.eth.cyril.util.configuration

Interface EditableConfiguration

All Superinterfaces:

Configuration

public interface EditableConfiguration
extends Configuration

A Configuration which can be edited.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EditableConfiguration.Modification
static interface	EditableConfiguration.ModificationListener
static class	EditableConfiguration.ModificationType

Method Summary

Modifier and Type	Method and Description
void	addModificationListener(EditableConfiguration.ModificationListener listener) Adds a new modification listener to this configuration.
void	remove(java.lang.String name) Removes the value of the given field.
void	removeModificationListener(EditableConfiguration.ModificationListener listener) Removes a modification listener from this configuration.
default void	rename(java.lang.String oldName, java.lang.String newName) Renames the field with the given name to the new name.
default void	set(java.lang.String name, java.lang.Object value) Sets the value at the given name to the new value.
void	setArray(java.lang.String name, ConfigurationArray value) Sets the value at the given name to the new value.
void	setBoolean(java.lang.String name, boolean value) Sets the value at the given name to the new value.
void	setInner(java.lang.String name, Configuration value) Sets the value at the given name to the new value.
void	setNumber(java.lang.String name, java.lang.Number value) Sets the value at the given name to the new value.
void	setString(java.lang.String name, java.lang.String value) Sets the value at the given name to the new value.

Methods inherited from interface org.eth.cyril.util.configuration.Configuration

get, getArray, getBoolean, getInner, getNumber, getProperties, getRawData, getString, hasArray, hasBoolean, hasInner, hasNumber, hasString, tryGet, tryGetArray, tryGetBoolean, tryGetInner, tryGetNumber, tryGetString

Method Detail

setNumber

void setNumber(java.lang.String name,
               java.lang.Number value)

Sets the value at the given name to the new value. Adds it if no value existed before.

Parameters:

name - The name of the property.

value - The value to set.

setBoolean

void setBoolean(java.lang.String name,
                boolean value)

Sets the value at the given name to the new value. Adds it if no value existed before.

Parameters:

name - The name of the property.

value - The value to set.

setString

void setString(java.lang.String name,
               java.lang.String value)

Sets the value at the given name to the new value. Adds it if no value existed before.

Parameters:

name - The name of the property.

value - The value to set.

setArray

void setArray(java.lang.String name,
              ConfigurationArray value)

Sets the value at the given name to the new value. Adds it if no value existed before.

Parameters:

name - The name of the property.

value - The value to set.

setInner

void setInner(java.lang.String name,
              Configuration value)

Sets the value at the given name to the new value. Adds it if no value existed before.

Parameters:

name - The name of the property.

value - The value to set.

set

default void set(java.lang.String name,
                 java.lang.Object value)

Sets the value at the given name to the new value. Adds it if no value existed before.

Parameters:

name - The name of the property.

value - The value to set. Must be of a type supported by a set* method.

rename

default void rename(java.lang.String oldName,
                    java.lang.String newName)

Renames the field with the given name to the new name. If a field exists with newName already, it is overwritten. Has no effect if no value existed at the old field.

Parameters:

oldName - The old name of the field.

newName - The new name of the field. May overwrite an existing field.

remove

void remove(java.lang.String name)

Removes the value of the given field. Has no effect if the given field dooesn't exist.

Parameters:

name - The name of the field.

addModificationListener

void addModificationListener(EditableConfiguration.ModificationListener listener)

Adds a new modification listener to this configuration. Has no effect if the modification listener already has been added to the configuration.

Parameters:

listener - The listener to be notified when the configuration is modified.

removeModificationListener

void removeModificationListener(EditableConfiguration.ModificationListener listener)

Removes a modification listener from this configuration. Has no effect if the modification listener hasn't been added to the configuration.

Parameters:

listener - The listener to not be notified when the configuration is modified anymore.