com.hp.of.lib.msg

Class OfmMutableGroupMod

java.lang.Object

com.hp.nbio.AbstractMessage

com.hp.of.lib.msg.OpenflowMessage

com.hp.of.lib.msg.OfmGroupMod

com.hp.of.lib.msg.OfmMutableGroupMod

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutableGroupMod
extends OfmGroupMod
implements MutableMessage

Mutable subclass of OfmGroupMod.

Author:

Simon Hunt

Field Summary

Fields inherited from class com.hp.nbio.AbstractMessage

length

Method Summary

Methods

Modifier and Type	Method and Description
OfmMutableGroupMod	addBucket(Bucket bucket) Adds a bucket to this group-mod message; Since 1.1.
void	clearXid() Clears the transaction ID field of this message (sets it to 0).
OfmMutableGroupMod	command(GroupModCommand cmd) Sets the group mod command; Since 1.1.
OfmMutableGroupMod	groupId(GroupId id) Sets the group id; Since 1.1.
OfmMutableGroupMod	groupType(GroupType type) Sets the group type; 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.hp.of.lib.msg.OfmGroupMod

getBuckets, getCommand, getGroupId, getGroupType, 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 OfmGroupMod

command

public OfmMutableGroupMod command(GroupModCommand cmd)

Sets the group mod command; Since 1.1.

Parameters:

cmd - the group-mod command

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.1

NullPointerException - if cmd is null

groupType

public OfmMutableGroupMod groupType(GroupType type)

Sets the group type; Since 1.1.

Parameters:

type - the group type

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.1

NullPointerException - if type is null

groupId

public OfmMutableGroupMod groupId(GroupId id)

Sets the group id; Since 1.1.

Parameters:

id - the group id

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.1

NullPointerException - if id is null

addBucket

public OfmMutableGroupMod addBucket(Bucket bucket)

Adds a bucket to this group-mod message; Since 1.1.

Parameters:

bucket - the bucket to add

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.1 or if the bucket version is not the same as this instance

NullPointerException - if bucket is null

IllegalArgumentException - if bucket is mutable