com.h3c.of.lib.msg

Class OfmMutableTableMod

java.lang.Object

com.h3c.nbio.AbstractMessage

com.h3c.of.lib.msg.OpenflowMessage

com.h3c.of.lib.msg.OfmTableMod

com.h3c.of.lib.msg.OfmMutableTableMod

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutableTableMod
extends OfmTableMod
implements MutableMessage

Mutable subclass of OfmTableMod.

Nested Class Summary

Nested classes/interfaces inherited from class com.h3c.of.lib.msg.OpenflowMessage

OpenflowMessage.Header

Field Summary

Fields inherited from class com.h3c.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).
OfmMutableTableMod	config(Set<TableConfig> flags) Sets the table configuration flags; Since 1.1; Deprecated in 1.3.
OfmMutableTableMod	tableId(TableId tableId) Sets the table id; Since 1.1.
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.h3c.of.lib.msg.OfmTableMod

getConfig, getTableId

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

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

Methods inherited from class java.lang.Object

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

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

getType, getXid

Methods inherited from interface com.h3c.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).

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 OfmTableMod

tableId

public OfmMutableTableMod tableId(TableId tableId)

Sets the table id; Since 1.1.

Note the special values:

• TableId.MAX : the maximum allowable value
• TableId.ALL : represents all tables

Parameters:

tableId - the table id

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version < 1.1

NullPointerException - if tableId is null

config

public OfmMutableTableMod config(Set<TableConfig> flags)

Sets the table configuration flags; Since 1.1; Deprecated in 1.3.

Since 1.3, the table config flags are reserved for future use.

Parameters:

flags - the table configuration flags to set

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is not 1.1 or 1.2