com.hp.sdn.dvc

Class DeviceInfoAdapter

java.lang.Object

com.hp.sdn.dvc.DeviceInfoAdapter

All Implemented Interfaces:

DeviceInfo, FacetProvider

public class DeviceInfoAdapter
extends Object
implements DeviceInfo

Device Info test adapter

Author:

Sean Humphress

Constructor Summary

Constructors

Constructor and Description
DeviceInfoAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
DeviceInfo	evolve() A request to "evolve" this device info instance to reflect current information that may have been collected.
String	exportData() Exports the contents of the device info into a string form.
<T extends Facet> T	getFacet(Class<T> facetClass) Returns an implementation of the specified facet class, or null if that facet is not supported by this provider.
Set<Class<? extends Facet>>	getFacetClasses() Returns the set of facet classes for the facets that this provider provides.
Set<String>	getFacetClassNames() Returns the set of facet class names for the facets that this provider provides.
int	getGeneration() Get the generation number of the device info.
String	getTypeName() Returns the name of the device type backing this instance.
boolean	importData(String data) Imports the contents of the device info from the specified export-encoded string.
boolean	isSupported(Class<? extends Facet> facetClass) Returns true if the specified facet class is supported by this provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceInfoAdapter

public DeviceInfoAdapter()

Method Detail

getFacetClasses

public Set<Class<? extends Facet>> getFacetClasses()

Description copied from interface: FacetProvider

Returns the set of facet classes for the facets that this provider provides.

Specified by:

getFacetClasses in interface FacetProvider

Returns:

the set of facet classes

getFacetClassNames

public Set<String> getFacetClassNames()

Description copied from interface: FacetProvider

Returns the set of facet class names for the facets that this provider provides. Implementations should iterate across their implementation of FacetProvider.getFacetClasses() and populate the returned set with the result of calling Class.getName() on each class.

Specified by:

getFacetClassNames in interface FacetProvider

Returns:

the set of facet class names

isSupported

public boolean isSupported(Class<? extends Facet> facetClass)

Description copied from interface: FacetProvider

Returns true if the specified facet class is supported by this provider. The following implementation (or its equivalent) should hold true:

 public boolean isSupported(Class<? extends Facet> facetClass) {
     return FacetProvider.getFacetClasses()().contains(facetClass);
 }
 

Specified by:

isSupported in interface FacetProvider

Parameters:

facetClass - a facet class

Returns:

true if this provider supports that class of facet

getFacet

public <T extends Facet> T getFacet(Class<T> facetClass)

Description copied from interface: FacetProvider

Returns an implementation of the specified facet class, or null if that facet is not supported by this provider.

Specified by:

getFacet in interface FacetProvider

Type Parameters:

T - Facet type

Parameters:

facetClass - the class of the required facet

Returns:

a facet implementation

getTypeName

public String getTypeName()

Description copied from interface: DeviceInfo

Returns the name of the device type backing this instance. This method should delegate to the context method of the same name.

Specified by:

getTypeName in interface DeviceInfo

Returns:

the device type name

evolve

public DeviceInfo evolve()

Description copied from interface: DeviceInfo

A request to "evolve" this device info instance to reflect current information that may have been collected. Note that the returned instance is not guaranteed to be 'this' instance.

If the device info contains additional information to warrant further evolution then an altered or a different device info instance will be returned, whose generation number will be greater than the original device info generation number. Otherwise, the same device info instance may be returned with its generation number unchanged to indicate that no evolution occurred.

A recommended pattern of use is

 DeviceInfo info = ...
 int originalGeneration = info.getGeneration();
 ...
 // Attempt to evolve the underlying device type when we think more 
 // information about the underlying device may available to to 
 // further narrow the specific of the device type.
 info = info.evolve();
 
 if (originalGeneration < info.getGeneration())
     // Device info has evolved
     ...
 else
     // Device info did not evolve any further
     ...
 
 

Specified by:

evolve in interface DeviceInfo

Returns:

an evolved info instance

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.

Specified by:

getGeneration in interface DeviceInfo

Returns:

generation number of the device info

exportData

public String exportData()

Description copied from interface: DeviceInfo

Exports the contents of the device info into a string form.

Specified by:

exportData in interface DeviceInfo

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)

Description copied from interface: DeviceInfo

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.

Specified by:

importData in interface DeviceInfo

Parameters:

data - string previously encoded via DeviceInfo.exportData()

Returns:

true if the import was successful; false otherwise