com.hp.sdn.device

Class KeyDeviceInfo

java.lang.Object

com.hp.device.AbstractDeviceInfo

com.hp.device.DefaultDeviceInfo

com.hp.sdn.device.KeyDeviceInfo

All Implemented Interfaces:

DeviceInfo, FacetProvider, MutableDeviceInfo

public class KeyDeviceInfo
extends DefaultDeviceInfo

Extension of Device Info that stores device keys.

Author:

Sean Humphress

Constructor Summary

Constructors

Constructor and Description
KeyDeviceInfo(DefaultDeviceInfo ddi) DefaultDeviceInfo copy constructor
KeyDeviceInfo(DefaultDeviceType deviceType)
KeyDeviceInfo(KeyDeviceInfo kdi) KeyDeviceInfo copy constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(String key) Clears the property for the given key.
String	exportData() Export device keys and parent data in json format.
boolean	importData(String data) Import device keys and parent data from json format.
Key	key(Key.Type type) Get the key by type.
void	remove(Key.Type type) Remove the key type.
void	set(String key, boolean value) Sets the given boolean value for the given key.
void	set(String key, int value) Sets the given value for the given key.
void	set(String key, long value) Sets the given value for the given key.
void	set(String key, String value) Sets the given value for the given key.
void	setKey(Key key) Store the key.

Methods inherited from class com.hp.device.DefaultDeviceInfo

evolve, get, get, getBoolean, getBoolean, getGeneration, getInt, getInt, getLong, getLong, getNodeCount, hasProperty, incrementGeneration, keys, toDebugString, toString

Methods inherited from class com.hp.device.AbstractDeviceInfo

getDeviceType, getFacet, getFacetClasses, getFacetClassNames, getType, getTypeName, isSupported, setDeviceType

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyDeviceInfo

public KeyDeviceInfo(DefaultDeviceType deviceType)

KeyDeviceInfo

public KeyDeviceInfo(KeyDeviceInfo kdi)

KeyDeviceInfo copy constructor

Parameters:

kdi - key device info to copy

KeyDeviceInfo

public KeyDeviceInfo(DefaultDeviceInfo ddi)

DefaultDeviceInfo copy constructor

Parameters:

ddi - default device info to copy

Method Detail

key

public Key key(Key.Type type)

Get the key by type.

Parameters:

type - Key.TYPE

Returns:

key if found, else null

setKey

public void setKey(Key key)

Store the key.

Parameters:

key - device key, type will be read from key

remove

public void remove(Key.Type type)

Remove the key type.

Parameters:

type - key type

exportData

public String exportData()

Export device keys and parent data in json format.

Specified by:

exportData in interface DeviceInfo

Overrides:

exportData in class DefaultDeviceInfo

Returns:

string containing an export encoding of the internal data, suitable to be re-imported via DeviceInfo.importData(String)

importData

public boolean importData(String data)

Import device keys and parent data from json format.

Specified by:

importData in interface DeviceInfo

Overrides:

importData in class DefaultDeviceInfo

Parameters:

data - string previously encoded via DeviceInfo.exportData()

Returns:

true if the import was successful; false otherwise

set

public void set(String key,
       String value)

Description copied from class: DefaultDeviceInfo

Sets the given value for the given key.

Overrides:

set in class DefaultDeviceInfo

Parameters:

key - the key

value - the value

set

public void set(String key,
       int value)

Description copied from class: DefaultDeviceInfo

Sets the given value for the given key.

Overrides:

set in class DefaultDeviceInfo

Parameters:

key - the key

value - the value

set

public void set(String key,
       long value)

Description copied from class: DefaultDeviceInfo

Sets the given value for the given key.

Overrides:

set in class DefaultDeviceInfo

Parameters:

key - the key

value - the value

set

public void set(String key,
       boolean value)

Description copied from class: DefaultDeviceInfo

Sets the given boolean value for the given key.

Overrides:

set in class DefaultDeviceInfo

Parameters:

key - the key

value - the value

clear

public void clear(String key)

Description copied from class: DefaultDeviceInfo

Clears the property for the given key. Note that a property is automatically cleared during the internal call to AbstractHierarchicalFileConfiguration.setProperty(String, Object)

Overrides:

clear in class DefaultDeviceInfo

Parameters:

key - the key