org.onosproject.net.device

Class DefaultDeviceDescription

java.lang.Object

org.onosproject.net.AbstractDescription

org.onosproject.net.device.DefaultDeviceDescription

All Implemented Interfaces:

Annotated, Description, DeviceDescription

public class DefaultDeviceDescription
extends AbstractDescription
implements DeviceDescription

Default implementation of immutable device description entity.

Constructor Summary

Constructors

Constructor and Description
DefaultDeviceDescription(DeviceDescription base, SparseAnnotations... annotations) Creates a device description using the supplied information.
DefaultDeviceDescription(URI uri, Device.Type type, String manufacturer, String hwVersion, String swVersion, String serialNumber, org.onlab.packet.ChassisId chassis, SparseAnnotations... annotations) Creates a device description using the supplied information.

Method Summary

Modifier and Type	Method and Description
org.onlab.packet.ChassisId	chassisId() Returns a device chassis id.
URI	deviceURI() Protocol/provider specific URI that can be used to encode the identity information required to communicate with the device externally, e.g.
String	hwVersion() Returns the device hardware version.
String	manufacturer() Returns the device manufacturer name.
String	serialNumber() Returns the device serial number.
String	swVersion() Returns the device software version.
String	toString()
Device.Type	type() Returns the type of the infrastructure device.

Methods inherited from class org.onosproject.net.AbstractDescription

annotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.net.Description

annotations

Constructor Detail

DefaultDeviceDescription

public DefaultDeviceDescription(URI uri,
                                Device.Type type,
                                String manufacturer,
                                String hwVersion,
                                String swVersion,
                                String serialNumber,
                                org.onlab.packet.ChassisId chassis,
                                SparseAnnotations... annotations)

Creates a device description using the supplied information.

Parameters:

uri - device URI

type - device type

manufacturer - device manufacturer

hwVersion - device HW version

swVersion - device SW version

serialNumber - device serial number

chassis - chasis id

annotations - optional key/value annotations map

DefaultDeviceDescription

public DefaultDeviceDescription(DeviceDescription base,
                                SparseAnnotations... annotations)

Creates a device description using the supplied information.

Parameters:

base - DeviceDescription to basic information

annotations - Annotations to use.

Method Detail

deviceURI

public URI deviceURI()

Description copied from interface: DeviceDescription

Protocol/provider specific URI that can be used to encode the identity information required to communicate with the device externally, e.g. datapath ID.

Specified by:

deviceURI in interface DeviceDescription

Returns:

provider specific URI for the device

type

public Device.Type type()

Description copied from interface: DeviceDescription

Returns the type of the infrastructure device.

Specified by:

type in interface DeviceDescription

Returns:

type of the device

manufacturer

public String manufacturer()

Description copied from interface: DeviceDescription

Returns the device manufacturer name.

Specified by:

manufacturer in interface DeviceDescription

Returns:

manufacturer name

hwVersion

public String hwVersion()

Description copied from interface: DeviceDescription

Returns the device hardware version.

Specified by:

hwVersion in interface DeviceDescription

Returns:

hardware version

swVersion

public String swVersion()

Description copied from interface: DeviceDescription

Returns the device software version.

Specified by:

swVersion in interface DeviceDescription

Returns:

software version

serialNumber

public String serialNumber()

Description copied from interface: DeviceDescription

Returns the device serial number.

Specified by:

serialNumber in interface DeviceDescription

Returns:

serial number

chassisId

public org.onlab.packet.ChassisId chassisId()

Description copied from interface: DeviceDescription

Returns a device chassis id.

Specified by:

chassisId in interface DeviceDescription

Returns:

chassis id

toString

public String toString()

Overrides:

toString in class Object