DefaultDeviceInfo (sdn-apidoc 2.5.14 API)

java.lang.Object
- com.hp.device.AbstractDeviceInfo
- - com.hp.device.DefaultDeviceInfo

All Implemented Interfaces:

DeviceInfo, FacetProvider, MutableDeviceInfo

Direct Known Subclasses:

KeyDeviceInfo
```
public class DefaultDeviceInfo
extends AbstractDeviceInfo
```
A default implementation of DeviceInfo which will likely be sufficient for most needs. A Properties instance is used as the backing store, with key/value pairs representing the data.

Author:

Simon Hunt, Frank Wood

Constructor Summary

Constructors
Constructor and Description

DefaultDeviceInfo(DefaultDeviceType deviceType)
Construct a new instance.

Constructors
Constructor and Description
`DefaultDeviceInfo(DefaultDeviceType deviceType)` Construct a new instance.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear(String key)` Clears the property for the given key.
`DeviceInfo`	`evolve()` This method delegates to `DeviceType.evolve(com.hp.device.DeviceInfo)` on the backing device type, passing this instance as the context.
`String`	`exportData()` Exports the contents of the device info into a string form.
`String`	`get(String key)` Returns the string value stored under the given key, or null if the key does not exist.
`String`	`get(String key, String defaultValue)` Returns the string value stored under the given key.
`boolean`	`getBoolean(String key)` Returns the boolean value stored under the given key, or null if the key does not exist.
`boolean`	`getBoolean(String key, boolean defaultValue)` Returns the boolean value stored under the given key.
`int`	`getGeneration()` Get the generation number of the device info.
`int`	`getInt(String key)` Returns the integer value stored under the given key, or null if the key does not exist.
`int`	`getInt(String key, int defaultValue)` Returns the string value stored under the given key.
`long`	`getLong(String key)` Returns the long value stored under the given key, or null if the key does not exist.
`long`	`getLong(String key, long defaultValue)` Returns the long value stored under the given key.
`int`	`getNodeCount(String key)` Returns the count of "subnodes" under the node for the given key.
`boolean`	`hasProperty(String key)` Gives an indication whether the property with the specified key is present or not.
`boolean`	`importData(String data)` Imports the contents of the device info from the specified export-encoded string.
`void`	`incrementGeneration()` Increments the generation number of the device info by 1.
`Set<String>`	`keys()` Returns the set of keys.
`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.
`String`	`toDebugString()` Get the device info properties as an XML-encoded string.
`String`	`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
  - DefaultDeviceInfo
```
public DefaultDeviceInfo(DefaultDeviceType deviceType)
```
    Construct a new instance.
    
    Parameters:
    deviceType - the underlying (initial) device type
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toDebugString
```
public String toDebugString()
```
    Get the device info properties as an XML-encoded string.
    
    Returns:
    XML encoded string of device properties
  - evolve
```
public DeviceInfo evolve()
```
    This method delegates to DeviceType.evolve(com.hp.device.DeviceInfo) on the backing device type, passing this instance as the context.
    It is the responsibility of the delegate to properly update the generation number if the device type evolved. If the new instance is also of DefaultDeviceInfo class, this update should occur via incrementGeneration().
    
    Returns:
    a possibly evolved instance of this device info
  - getGeneration
```
public int getGeneration()
```
    Description copied from interface: DeviceInfo
    
    Get the generation number of the device info. It represents the number of times the device info has undergone type evolution since its original creation via one of the DeviceInfoProvider.create() methods.
    
    Returns:
    generation number of the device info
  - incrementGeneration
```
public void incrementGeneration()
```
    Increments the generation number of the device info by 1. Intended for use by device type implementations to record generation change.
  - exportData
```
public String exportData()
```
    Exports the contents of the device info into a string form.
    This implementation produces an XML-encoded string of internal properties.
    
    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)
```
    Imports the contents of the device info from the specified export-encoded string.
    There is no mandate to be able to import data exported from a device info of a different type.
    This implementation loads the internal properties from the specified XML-encoded string.
    
    Parameters:
    data - string previously encoded via DeviceInfo.exportData()
    
    Returns:
    true if the import was successful; false otherwise
  - keys
```
public Set<String> keys()
```
    Returns the set of keys.
    
    Returns:
    the set of keys
  - hasProperty
```
public boolean hasProperty(String key)
```
    Gives an indication whether the property with the specified key is present or not.
    
    Parameters:
    key - the key
    
    Returns:
    true if property is present; false otherwise
  - get
```
public String get(String key)
```
    Returns the string value stored under the given key, or null if the key does not exist.
    
    Parameters:
    key - the key
    
    Returns:
    the value, or null
  - get
```
public String get(String key,
         String defaultValue)
```
    Returns the string value stored under the given key. If no such key exists, the given default value is returned instead.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value associated with the key, if it exists, else default value
  - getInt
```
public int getInt(String key)
```
    Returns the integer value stored under the given key, or null if the key does not exist.
    
    Parameters:
    key - the key
    
    Returns:
    the value, or null
  - getInt
```
public int getInt(String key,
         int defaultValue)
```
    Returns the string value stored under the given key. If no such key exists, the given default value is returned instead.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value associated with the key, if it exists, else default value
  - getLong
```
public long getLong(String key)
```
    Returns the long value stored under the given key, or null if the key does not exist.
    
    Parameters:
    key - the key
    
    Returns:
    the value, or null
  - getLong
```
public long getLong(String key,
           long defaultValue)
```
    Returns the long value stored under the given key. If no such key exists, the given default value is returned instead.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value associated with the key, if it exists, else default value
  - getBoolean
```
public boolean getBoolean(String key)
```
    Returns the boolean value stored under the given key, or null if the key does not exist.
    
    Parameters:
    key - the key
    
    Returns:
    the value, or null
  - getBoolean
```
public boolean getBoolean(String key,
                 boolean defaultValue)
```
    Returns the boolean value stored under the given key. If no such key exists, the given default value is returned instead.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value associated with the key, if it exists, else default value
  - set
```
public void set(String key,
       String value)
```
    Sets the given value for the given key.
    
    Parameters:
    key - the key
    value - the value
  - set
```
public void set(String key,
       int value)
```
    Sets the given value for the given key.
    
    Parameters:
    key - the key
    value - the value
  - set
```
public void set(String key,
       long value)
```
    Sets the given value for the given key.
    
    Parameters:
    key - the key
    value - the value
  - set
```
public void set(String key,
       boolean value)
```
    Sets the given boolean value for the given key.
    
    Parameters:
    key - the key
    value - the value
  - clear
```
public void clear(String key)
```
    Clears the property for the given key. Note that a property is automatically cleared during the internal call to AbstractHierarchicalFileConfiguration.setProperty(String, Object)
    
    Parameters:
    key - the key
  - getNodeCount
```
public int getNodeCount(String key)
```
    Returns the count of "subnodes" under the node for the given key.
    
    Parameters:
    key - the key
    
    Returns:
    the count of subnodes

Class DefaultDeviceInfo

Constructor Summary

Method Summary

Methods inherited from class com.hp.device.AbstractDeviceInfo

Methods inherited from class java.lang.Object

Constructor Detail

DefaultDeviceInfo

Method Detail

toString

toDebugString

evolve

getGeneration

incrementGeneration

exportData

importData

keys

hasProperty

get

get

getInt

getInt

getLong

getLong

getBoolean

getBoolean

set

set

set

set

clear

getNodeCount