org.opendaylight.vtn.manager.internal.util

Class ConfigFileUpdater<K,V>

java.lang.Object

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

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

Type Parameters:

K - The type of the identifier which identifies data.

V - The type of the data.

public abstract class ConfigFileUpdater<K,V>
extends AbstractConfigFileUpdater<K,V>

ConfigFileUpdater describes changes to be applied to the configuration file.

Note that this class is not synchronized.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigFileUpdater(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, boolean created) Add the created or updated data to be saved into the configuration file.
protected void	onRemoved(K key) Invoked when the configuration file associated with the given data is removed.
protected boolean	onUpdated(K key, V value) Invoked when the given data is saved into the configuration file.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.AbstractConfigFileUpdater

addUpdated, apply, fixUp, isChanged, isRemoved, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigFileUpdater

protected ConfigFileUpdater(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,
                                boolean created)

Add the created or 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.

created - true means that the given data has been newly created.

Returns:

true only if the given data was actually added.

addRemoved

public final boolean addRemoved(K key)

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

Overrides:

addRemoved in class AbstractConfigFileUpdater<K,V>

Parameters:

key - The identifier of the removed data.

Returns:

true only if the given data was actually added.

onUpdated

protected final boolean onUpdated(K key,
                                  V value)

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

Specified by:

onUpdated in class AbstractConfigFileUpdater<K,V>

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 final void onRemoved(K key)

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

Specified by:

onRemoved in class AbstractConfigFileUpdater<K,V>

Parameters:

key - The identifier of the removed data.