org.opendaylight.vtn.manager.internal.util

Class AbstractConfigFileUpdater<K,V>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.AbstractConfigFileUpdater<K,V>

Type Parameters:

K - The type of the identifier which identifies data.

V - The type of the data.

Direct Known Subclasses:

ConfigFileUpdater

public abstract class AbstractConfigFileUpdater<K,V>
extends Object

AbstractConfigFileUpdater describes changes to be applied to the configuration file.

Note that this class is not synchronized.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConfigFileUpdater(XmlConfigFile.Type ftype, String desc) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	addRemoved(K key) Add the removed data to be removed from the configuration file.
boolean	addUpdated(K key, V value) Add the updated data to be saved into the configuration file.
void	apply(org.slf4j.Logger logger) Apply changes to the configuration file.
protected void	fixUp(org.slf4j.Logger logger) Fix up changes before applying.
boolean	isChanged(K key) Determine whether the contents of the specified data is changed or not.
boolean	isRemoved(K key) Determine whether the data specified by the given key has been removed or not.
protected abstract void	onRemoved(K key) Invoked when the configuration file associated with the given data is removed.
protected abstract boolean	onUpdated(K key, V value) Invoked when the given data is saved into the configuration file.
void	setChanged(K key) Mark the specified data as changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfigFileUpdater

protected AbstractConfigFileUpdater(XmlConfigFile.Type ftype,
                                    String desc)

Construct a new instance.

Parameters:

ftype - The type of the XML configuration file.

desc - A brief description about the target data.

Method Detail

addUpdated

public final boolean addUpdated(K key,
                                V value)

Add the updated data to be saved into the configuration file.

Parameters:

key - The identifier of the given data.

value - The value to be saved into the configuration file.

Returns:

true only if the given data was actually added.

addRemoved

public boolean addRemoved(K key)

Add the removed data to be removed from the configuration file.

Parameters:

key - The identifier of the removed data.

Returns:

true only if the given data was actually added.

isRemoved

public boolean isRemoved(K key)

Determine whether the data specified by the given key has been removed or not.

Parameters:

key - The identifier of the data.

Returns:

true only if the specified data has been removed.

setChanged

public void setChanged(K key)

Mark the specified data as changed.

Parameters:

key - The identifier of the changed data.

isChanged

public boolean isChanged(K key)

Determine whether the contents of the specified data is changed or not.

Parameters:

key - The identifier of the data.

Returns:

true only if the contents of the specified data is changed.

apply

public final void apply(org.slf4j.Logger logger)

Apply changes to the configuration file.

Parameters:

logger - A Logger instance.

fixUp

protected void fixUp(org.slf4j.Logger logger)

Fix up changes before applying.

This method in this class does nothing. Subclass can override this method to insert hook just before applying changes.

Parameters:

logger - A Logger instance.

onUpdated

protected abstract boolean onUpdated(K key,
                                     V value)

Invoked when the given data is saved into the configuration file.

Parameters:

key - The identifier of the given data.

value - The value to be saved into the configuration file.

Returns:

true if the given data is newly created data. Otherwise false.

onRemoved

protected abstract void onRemoved(K key)

Invoked when the configuration file associated with the given data is removed.

Parameters:

key - The identifier of the removed data.