java.lang.Object
- org.onosproject.net.AnnotationKeys

```
public final class AnnotationKeys
extends Object
```
Collection of keys for annotation.
Number of the annotation keys have been deprecated as the use of annotations is being phased out and instead network configuration subsystem is being phased-in for majority of model meta-data.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADMIN_STATE`	Annotation key for the admin state.
`static String`	`AVAILABILITY`	Annotation key for availability.
`static String`	`BANDWIDTH`	Annotation key for bandwidth.
`static String`	`CHANNEL_ID`	Annotation key for the channel id.
`static String`	`CONNECTION_TYPE`	Annotation key for UI connection type (the style for host link rendering).
`static String`	`DATAPATH_DESCRIPTION`	Annotation key for the datapath description.
`static String`	`DELAY`	Annotation key for delay.
`static String`	`DRIVER`	Annotation key for the device driver name.
`static String`	`DURABLE`	Annotation key for durable links.
`static String`	`FLAPPING`	Annotation key for flapping.
`static String`	`GRID_X`	Annotation key for grid-X (e.g.
`static String`	`GRID_Y`	Annotation key for grid-Y (e.g.
`static String`	`JITTER`	Annotation key for jitter.
`static String`	`LATENCY`	Annotation key for latency.
`static String`	`LATITUDE`	Annotation key for latitude (e.g.
`static String`	`LAYER`	Annotation key for the protocol layer.
`static String`	`LOC_TYPE`	Annotation key for UI location type of device/host (either 'geo' or 'grid').
`static String`	`LONGITUDE`	Annotation key for longitude (e.g.
`static String`	`LOSS`	Annotation key for loss.
`static String`	`MANAGEMENT_ADDRESS`	Annotation key for the management address.
`static String`	`METERED`	Annotation key for identifying a metered link.
`static String`	`METERED_USAGE`	Annotation key for data usage on a metered link.
`static String`	`METRIC`	Annotation key for link metric; used by `MetricLinkWeight` function.
`static String`	`NAME`	Annotation key for instance name.
`static String`	`OPTICAL_WAVES`	Annotation key for the number of optical waves.
`static String`	`OWNER`	Annotation key for device owner.
`static String`	`PASSWORD`	Annotation key for the password.
`static String`	`PORT_IN`	Annotation key for the optical channel receiving/in port (RX).
`static String`	`PORT_MAC`	Annotation key for the port mac.
`static String`	`PORT_NAME`	Annotation key for the port name.
`static String`	`PORT_OUT`	Annotation key for the optical channel port transmitting/out port (TX).
`static String`	`PROTECTED`	Link annotation key to express that a Link is backed by underlying protection mechanism.
`static String`	`PROTOCOL`	Annotation key for southbound protocol.
`static String`	`RACK_ADDRESS`	Annotation key for device location.
`static String`	`REST_SERVER`	Annotation key for REST server identifier.
`static String`	`ROUTER_ID`	Annotation key for the router ID.
`static String`	`SSHKEY`	Annotation key for the sshkey.
`static String`	`STATIC_LAMBDA`	Annotation key for the static lambda.
`static String`	`STATIC_PORT`	Annotation key for the static port.
`static String`	`TIER`	Annotation key for identifying the tier ranking of a link.
`static String`	`TYPE`	Deprecated. since Cardinal
`static String`	`UI_TYPE`	Annotation key for UI type (the glyph ID for rendering).
`static String`	`USERNAME`	Annotation key for the username.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static double`	`getAnnotatedValue(Annotated annotated, String key)`	Returns the value annotated object for the specified annotation key.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    Annotation key for instance name.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
@Deprecated
public static final String TYPE
```
    Deprecated.
    since Cardinal
    
    Annotation key for instance type (e.g. host type).
    
    See Also:
    
    Constant Field Values
  - UI_TYPE
```
public static final String UI_TYPE
```
    Annotation key for UI type (the glyph ID for rendering).
    
    See Also:
    
    Constant Field Values
  - CONNECTION_TYPE
```
public static final String CONNECTION_TYPE
```
    Annotation key for UI connection type (the style for host link rendering).
    
    See Also:
    
    Constant Field Values
  - LOC_TYPE
```
public static final String LOC_TYPE
```
    Annotation key for UI location type of device/host (either 'geo' or 'grid').
    
    See Also:
    
    Constant Field Values
  - LATITUDE
```
public static final String LATITUDE
```
    Annotation key for latitude (e.g. latitude of device/host in a geo-layout).
    
    See Also:
    
    Constant Field Values
  - LONGITUDE
```
public static final String LONGITUDE
```
    Annotation key for longitude (e.g. longitude of device/host in a geo-layout).
    
    See Also:
    
    Constant Field Values
  - GRID_Y
```
public static final String GRID_Y
```
    Annotation key for grid-Y (e.g. y-coordinate of device/host in a grid-layout).
    
    See Also:
    
    Constant Field Values
  - GRID_X
```
public static final String GRID_X
```
    Annotation key for grid-X (e.g. x-coordinate of device/host in a grid-layout).
    
    See Also:
    
    Constant Field Values
  - PROTOCOL
```
public static final String PROTOCOL
```
    Annotation key for southbound protocol.
    
    See Also:
    
    Constant Field Values
  - DRIVER
```
public static final String DRIVER
```
    Annotation key for the device driver name.
    
    See Also:
    
    Constant Field Values
  - DURABLE
```
public static final String DURABLE
```
    Annotation key for durable links.
    
    See Also:
    
    Constant Field Values
  - METRIC
```
public static final String METRIC
```
    Annotation key for link metric; used by MetricLinkWeight function.
    
    See Also:
    
    Constant Field Values
  - LATENCY
```
public static final String LATENCY
```
    Annotation key for latency. The value of this key is expected to be latency in nanosecond.
    
    See Also:
    
    Constant Field Values
  - BANDWIDTH
```
public static final String BANDWIDTH
```
    Annotation key for bandwidth. The value for this key is interpreted as Mbps.
    
    See Also:
    
    Constant Field Values
  - OPTICAL_WAVES
```
public static final String OPTICAL_WAVES
```
    Annotation key for the number of optical waves.
    
    See Also:
    
    Constant Field Values
  - PORT_NAME
```
public static final String PORT_NAME
```
    Annotation key for the port name.
    
    See Also:
    
    Constant Field Values
  - PORT_IN
```
public static final String PORT_IN
```
    Annotation key for the optical channel receiving/in port (RX).
    
    See Also:
    
    Constant Field Values
  - PORT_OUT
```
public static final String PORT_OUT
```
    Annotation key for the optical channel port transmitting/out port (TX).
    
    See Also:
    
    Constant Field Values
  - PORT_MAC
```
public static final String PORT_MAC
```
    Annotation key for the port mac.
    
    See Also:
    
    Constant Field Values
  - ADMIN_STATE
```
public static final String ADMIN_STATE
```
    Annotation key for the admin state. The value of this key is expected to be "enabled" or "disabled"
    
    See Also:
    
    Constant Field Values
  - ROUTER_ID
```
public static final String ROUTER_ID
```
    Annotation key for the router ID.
    
    See Also:
    
    Constant Field Values
  - STATIC_LAMBDA
```
public static final String STATIC_LAMBDA
```
    Annotation key for the static lambda.
    
    See Also:
    
    Constant Field Values
  - STATIC_PORT
```
public static final String STATIC_PORT
```
    Annotation key for the static port.
    
    See Also:
    
    Constant Field Values
  - RACK_ADDRESS
```
public static final String RACK_ADDRESS
```
    Annotation key for device location.
    
    See Also:
    
    Constant Field Values
  - OWNER
```
public static final String OWNER
```
    Annotation key for device owner.
    
    See Also:
    
    Constant Field Values
  - CHANNEL_ID
```
public static final String CHANNEL_ID
```
    Annotation key for the channel id.
    
    See Also:
    
    Constant Field Values
  - MANAGEMENT_ADDRESS
```
public static final String MANAGEMENT_ADDRESS
```
    Annotation key for the management address.
    
    See Also:
    
    Constant Field Values
  - USERNAME
```
public static final String USERNAME
```
    Annotation key for the username.
    
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    Annotation key for the password.
    
    See Also:
    
    Constant Field Values
  - PROTECTED
```
public static final String PROTECTED
```
    Link annotation key to express that a Link is backed by underlying protection mechanism.
    
    See Also:
    
    Constant Field Values
  - REST_SERVER
```
public static final String REST_SERVER
```
    Annotation key for REST server identifier.
    
    See Also:
    
    Constant Field Values
  - SSHKEY
```
public static final String SSHKEY
```
    Annotation key for the sshkey.
    
    See Also:
    
    Constant Field Values
  - LAYER
```
public static final String LAYER
```
    Annotation key for the protocol layer.
    
    See Also:
    
    Constant Field Values
  - JITTER
```
public static final String JITTER
```
    Annotation key for jitter. The value of this key is expected to be jitter in seconds
    
    See Also:
    
    Constant Field Values
  - DELAY
```
public static final String DELAY
```
    Annotation key for delay. The value of this key is expected to be delay in seconds
    
    See Also:
    
    Constant Field Values
  - LOSS
```
public static final String LOSS
```
    Annotation key for loss. The value of this key is expected to be loss in percentage.
    
    See Also:
    
    Constant Field Values
  - AVAILABILITY
```
public static final String AVAILABILITY
```
    Annotation key for availability. The value of this key is expected to be availability as a percentage
    
    See Also:
    
    Constant Field Values
  - FLAPPING
```
public static final String FLAPPING
```
    Annotation key for flapping. The value of this key is expected to be a subjective percentage for flapping
    
    See Also:
    
    Constant Field Values
  - METERED
```
public static final String METERED
```
    Annotation key for identifying a metered link. The value of this key is expected to be a boolean for metered as true/false.
    
    See Also:
    
    Constant Field Values
  - METERED_USAGE
```
public static final String METERED_USAGE
```
    Annotation key for data usage on a metered link. The value of this key is expected to be a percentage of the data available within the plan.
    
    See Also:
    
    Constant Field Values
  - TIER
```
public static final String TIER
```
    Annotation key for identifying the tier ranking of a link. Links with a lower tier would be selected in the path over links with a higher tier. The value of this key is expected to be a number that represents the tier value.
    
    See Also:
    
    Constant Field Values
  - DATAPATH_DESCRIPTION
```
public static final String DATAPATH_DESCRIPTION
```
    Annotation key for the datapath description. Provides a human readable description of a given datapath. Used, for instance, when an Openflow switch connects to the controller, in the response to the OFPMP_DESC request
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAnnotatedValue
```
public static double getAnnotatedValue(Annotated annotated,
                                       String key)
```
    Returns the value annotated object for the specified annotation key. The annotated value is expected to be String that can be parsed as double. If parsing fails, the returned value will be 1.0.
    
    Parameters:
    
    annotated - annotated object whose annotated value is obtained
    
    key - key of annotation
    
    Returns:
    
    double value of annotated object for the specified key

Class AnnotationKeys

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

TYPE

UI_TYPE

CONNECTION_TYPE

LOC_TYPE

LATITUDE

LONGITUDE

GRID_Y

GRID_X

PROTOCOL

DRIVER

DURABLE

METRIC

LATENCY

BANDWIDTH

OPTICAL_WAVES

PORT_NAME

PORT_IN

PORT_OUT

PORT_MAC

ADMIN_STATE

ROUTER_ID

STATIC_LAMBDA

STATIC_PORT

RACK_ADDRESS

OWNER

CHANNEL_ID

MANAGEMENT_ADDRESS

USERNAME

PASSWORD

PROTECTED

REST_SERVER

SSHKEY

LAYER

JITTER

DELAY

LOSS

AVAILABILITY

FLAPPING

METERED

METERED_USAGE

TIER

DATAPATH_DESCRIPTION

Method Detail

getAnnotatedValue