OFType (OpenVirteX 0.0.3 API)

java.lang.Object
- java.lang.Enum<OFType>
- - org.openflow.protocol.OFType

All Implemented Interfaces:

Serializable, Comparable<OFType>
```
public enum OFType
extends Enum<OFType>
```
List of OpenFlow types and mappings to wire protocol value and derived classes

Author:

Rob Sherwood (rob.sherwood@stanford.edu), David Erickson (daviderickson@cs.stanford.edu)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BARRIER_REPLY`
`BARRIER_REQUEST`
`ECHO_REPLY`
`ECHO_REQUEST`
`ERROR`
`FEATURES_REPLY`
`FEATURES_REQUEST`
`FLOW_MOD`
`FLOW_REMOVED`
`GET_CONFIG_REPLY`
`GET_CONFIG_REQUEST`
`HELLO`
`PACKET_IN`
`PACKET_OUT`
`PORT_MOD`
`PORT_STATUS`
`QUEUE_GET_CONFIG_REPLY`
`QUEUE_GET_CONFIG_REQUEST`
`SET_CONFIG`
`STATS_REPLY`
`STATS_REQUEST`
`VENDOR`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Class<? extends OFMessage>`	`clazz`
`protected Constructor<? extends OFMessage>`	`constructor`
`protected Instantiable<OFMessage>`	`instantiable`
`protected byte`	`type`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addMapping(byte i, OFType t)` Adds a mapping from type value to OFType enum
`Constructor<? extends OFMessage>`	`getConstructor()` Returns the no-argument Constructor of the implementation class for this OFType
`Instantiable<OFMessage>`	`getInstantiable()`
`byte`	`getTypeValue()`
`OFMessage`	`newInstance()` Returns a new instance of the OFMessage represented by this OFType
`static void`	`removeMapping(byte i)` Remove a mapping from type value to OFType enum
`void`	`setInstantiable(Instantiable<OFMessage> instantiable)`
`Class<? extends OFMessage>`	`toClass()`
`static OFType`	`valueOf(Byte i)` Given a wire protocol OpenFlow type number, return the OFType associated with it
`static OFType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OFType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - HELLO
```
public static final OFType HELLO
```
  - ERROR
```
public static final OFType ERROR
```
  - ECHO_REQUEST
```
public static final OFType ECHO_REQUEST
```
  - ECHO_REPLY
```
public static final OFType ECHO_REPLY
```
  - VENDOR
```
public static final OFType VENDOR
```
  - FEATURES_REQUEST
```
public static final OFType FEATURES_REQUEST
```
  - FEATURES_REPLY
```
public static final OFType FEATURES_REPLY
```
  - GET_CONFIG_REQUEST
```
public static final OFType GET_CONFIG_REQUEST
```
  - GET_CONFIG_REPLY
```
public static final OFType GET_CONFIG_REPLY
```
  - SET_CONFIG
```
public static final OFType SET_CONFIG
```
  - PACKET_IN
```
public static final OFType PACKET_IN
```
  - FLOW_REMOVED
```
public static final OFType FLOW_REMOVED
```
  - PORT_STATUS
```
public static final OFType PORT_STATUS
```
  - PACKET_OUT
```
public static final OFType PACKET_OUT
```
  - FLOW_MOD
```
public static final OFType FLOW_MOD
```
  - PORT_MOD
```
public static final OFType PORT_MOD
```
  - STATS_REQUEST
```
public static final OFType STATS_REQUEST
```
  - STATS_REPLY
```
public static final OFType STATS_REPLY
```
  - BARRIER_REQUEST
```
public static final OFType BARRIER_REQUEST
```
  - BARRIER_REPLY
```
public static final OFType BARRIER_REPLY
```
  - QUEUE_GET_CONFIG_REQUEST
```
public static final OFType QUEUE_GET_CONFIG_REQUEST
```
  - QUEUE_GET_CONFIG_REPLY
```
public static final OFType QUEUE_GET_CONFIG_REPLY
```
- Field Detail
  - clazz
```
protected Class<? extends OFMessage> clazz
```
  - constructor
```
protected Constructor<? extends OFMessage> constructor
```
  - instantiable
```
protected Instantiable<OFMessage> instantiable
```
  - type
```
protected byte type
```
- Method Detail
  - values
```
public static OFType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (OFType c : OFType.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OFType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - addMapping
```
public static void addMapping(byte i,
              OFType t)
```
    Adds a mapping from type value to OFType enum
    
    Parameters:
    i - OpenFlow wire protocol type
    t - type
  - removeMapping
```
public static void removeMapping(byte i)
```
    Remove a mapping from type value to OFType enum
    
    Parameters:
    i - OpenFlow wire protocol type
  - valueOf
```
public static OFType valueOf(Byte i)
```
    Given a wire protocol OpenFlow type number, return the OFType associated with it
    
    Parameters:
    i - wire protocol number
    
    Returns:
    OFType enum type
  - getTypeValue
```
public byte getTypeValue()
```
    Returns:
    Returns the wire protocol value corresponding to this OFType
  - toClass
```
public Class<? extends OFMessage> toClass()
```
    Returns:
    return the OFMessage subclass corresponding to this OFType
  - getConstructor
```
public Constructor<? extends OFMessage> getConstructor()
```
    Returns the no-argument Constructor of the implementation class for this OFType
    
    Returns:
    the constructor
  - newInstance
```
public OFMessage newInstance()
```
    Returns a new instance of the OFMessage represented by this OFType
    
    Returns:
    the new object
  - getInstantiable
```
public Instantiable<OFMessage> getInstantiable()
```
    Returns:
    the instantiable
  - setInstantiable
```
public void setInstantiable(Instantiable<OFMessage> instantiable)
```
    Parameters:
    instantiable - the instantiable to set

Enum OFType

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

HELLO

ERROR

ECHO_REQUEST

ECHO_REPLY

VENDOR

FEATURES_REQUEST

FEATURES_REPLY

GET_CONFIG_REQUEST

GET_CONFIG_REPLY

SET_CONFIG

PACKET_IN

FLOW_REMOVED

PORT_STATUS

PACKET_OUT

FLOW_MOD

PORT_MOD

STATS_REQUEST

STATS_REPLY

BARRIER_REQUEST

BARRIER_REPLY

QUEUE_GET_CONFIG_REQUEST

QUEUE_GET_CONFIG_REPLY

Field Detail

clazz

constructor

instantiable

type

Method Detail

values

valueOf

addMapping

removeMapping

valueOf

getTypeValue

toClass

getConstructor

newInstance

getInstantiable

setInstantiable