com.hp.of.lib.msg

Class OfmMutableExperimenter

java.lang.Object

com.hp.nbio.AbstractMessage

com.hp.of.lib.msg.OpenflowMessage

com.hp.of.lib.msg.OfmExperimenter

com.hp.of.lib.msg.OfmMutableExperimenter

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutableExperimenter
extends OfmExperimenter
implements MutableMessage

Mutable subclass of OfmExperimenter.

Author:

Scott Simes

Field Summary

Fields inherited from class com.hp.nbio.AbstractMessage

length

Method Summary

Methods

Modifier and Type	Method and Description
void	clearXid() Clears the transaction ID field of this message (sets it to 0).
OfmMutableExperimenter	data(byte[] data) Sets the data; Since 1.0.
OfmMutableExperimenter	expId(ExperimenterId id) Sets the experimenter identifier; Since 1.1.
OfmMutableExperimenter	expId(int encodedId) Sets the experimenter identifier; Since 1.1.
OfmMutableExperimenter	expType(int expType) Sets the experimenter type; Since 1.2
OpenflowMessage	toImmutable() Returns an immutable instance of this message.
String	toString()
boolean	writable() Returns true if this mutable object is still writable.

Methods inherited from class com.hp.of.lib.msg.OfmExperimenter

getData, getExpId, getExpType, getId, toDebugString

Methods inherited from class com.hp.of.lib.msg.OpenflowMessage

decodeHeader, getType, getVersion, getXid, hex, hex, length, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hp.of.lib.msg.Message

getType, getXid

Methods inherited from interface com.hp.of.lib.Structure

getVersion, toDebugString

Method Detail

clearXid

public void clearXid()

Description copied from interface: MutableMessage

Clears the transaction ID field of this message (sets it to 0). This is provided for unit testing purposes, only.

Specified by:

clearXid in interface MutableMessage

toImmutable

public OpenflowMessage toImmutable()

Description copied from interface: MutableMessage

Returns an immutable instance of this message. In essence, converts this message to be read-only.

It is expected that the reference to this mutable message will be dropped. Note that all method calls invoked on a MutableMessage after toImmutable() has been invoked will result in an InvalidMutableException being thrown.

Specified by:

toImmutable in interface MutableMessage

Returns:

an immutable instance of this message.

writable

public boolean writable()

Description copied from interface: MutableObject

Returns true if this mutable object is still writable. That is, the #toImmutable() method (defined on a sub-interface) has not yet been invoked.

Specified by:

writable in interface MutableObject

Returns:

true if this mutable object is still writable

toString

public String toString()

Overrides:

toString in class OfmExperimenter

expId

public OfmMutableExperimenter expId(ExperimenterId id)

Sets the experimenter identifier; Since 1.1. Used to set the vendor identifier for 1.0.

Parameters:

id - the experimenter identifier

Returns:

self, for chaining

Throws:

NullPointerException - if id is null

InvalidMutableException - if this instance is no longer writable

expId

public OfmMutableExperimenter expId(int encodedId)

Sets the experimenter identifier; Since 1.1. Used to set the vendor identifier for 1.0.

Parameters:

encodedId - the encoded experimenter identifier

Returns:

self, for chaining

Throws:

NullPointerException - if encodedId is null

InvalidMutableException - if this instance is no longer writable

expType

public OfmMutableExperimenter expType(int expType)

Sets the experimenter type; Since 1.2

Parameters:

expType - the experimenter type

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.2

data

public OfmMutableExperimenter data(byte[] data)

Sets the data; Since 1.0.

Parameters:

data - the data

Returns:

self, for chaining

Throws:

NullPointerException - if data is null

InvalidMutableException - if this instance is no longer writable