org.opendaylight.vtn.manager.internal.util

Class XmlConfigFile

java.lang.Object

org.opendaylight.vtn.manager.internal.util.XmlConfigFile

public final class XmlConfigFile
extends Object

Helper class used to write configurations into a file in XML format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlConfigFile.Type Specify the type of configuration.

Method Summary

Modifier and Type	Method and Description
static boolean	delete(XmlConfigFile.Type type, String key) Delete the configuration file for the specified configuration.
static boolean	deleteAll(XmlConfigFile.Type type, Set<String> retain) Delete all the configuration files for the specified configuration.
static List<String>	getKeys(XmlConfigFile.Type type) Return a list of valid map keys saved in the configuration directory.
static void	init() Initialize the configuration directory for the VTN Manager.
static <T> T	load(XmlConfigFile.Type type, String key, Class<T> cls) Load a map entry from the file.
static boolean	save(XmlConfigFile.Type type, String key, Object value) Write a map entry to the XML file.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()

Initialize the configuration directory for the VTN Manager.

save

public static boolean save(XmlConfigFile.Type type,
                           String key,
                           Object value)

Write a map entry to the XML file.

Parameters:

type - The type of the configuration.

key - A key associated with the map entry.

value - A value to be saved into XML file. An object bound to XML root element needs to be specified.

Returns:

true on success. false on failure.

load

public static <T> T load(XmlConfigFile.Type type,
                         String key,
                         Class<T> cls)

Load a map entry from the file.

Type Parameters:

T - The type of object to be bound to XML element.

Parameters:

type - The type of the configuration.

key - A key associated with the map entry.

cls - The type of object to be bound to XML element.

Returns:

A map entry loaded from the file. null is returned on failure. The specified file will be deleted if this method returns null.

delete

public static boolean delete(XmlConfigFile.Type type,
                             String key)

Delete the configuration file for the specified configuration.

Parameters:

type - The type of the configuration.

key - A key associated with the map entry.

Returns:

true if the specified configuration file was deleted successfully. Otherwise false.

deleteAll

public static boolean deleteAll(XmlConfigFile.Type type,
                                Set<String> retain)

Delete all the configuration files for the specified configuration.

Parameters:

type - The type of the configuration.

retain - A set of map keys to be retained.

Returns:

true if the operation was successfully completed. false if at least one error occurred.

getKeys

public static List<String> getKeys(XmlConfigFile.Type type)

Return a list of valid map keys saved in the configuration directory.

Parameters:

type - The type of the configuration.

Returns:

A list of valid map keys.