com.h3c.of.lib.msg

Class OfmMutableMeterMod

java.lang.Object

com.h3c.nbio.AbstractMessage

com.h3c.of.lib.msg.OpenflowMessage

com.h3c.of.lib.msg.OfmMeterMod

com.h3c.of.lib.msg.OfmMutableMeterMod

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutableMeterMod
extends OfmMeterMod
implements MutableMessage

Mutable subclass of OfmMeterMod.

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
OfmMutableMeterMod	addBand(MeterBand band) Adds a meter band to this meter-mod message; Since 1.3.
void	clearXid() Clears the transaction ID field of this message (sets it to 0).
OfmMutableMeterMod	command(MeterModCommand cmd) Sets the meter mod command; Since 1.3.
OfmMutableMeterMod	meterFlags(Set<MeterFlag> flags) Sets the meter flags; Since 1.3.
OfmMutableMeterMod	meterId(MeterId meterId) Sets the meter id; Since 1.3.
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.OfmMeterMod

getBands, getCommand, getFlags, getMeterId, toDebugString

Methods inherited from class com.h3c.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.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 OfmMeterMod

command

public OfmMutableMeterMod command(MeterModCommand cmd)

Sets the meter mod command; Since 1.3.

Parameters:

cmd - the meter-mod command

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.3

NullPointerException - if cmd is null

meterFlags

public OfmMutableMeterMod meterFlags(Set<MeterFlag> flags)

Sets the meter flags; Since 1.3.

Parameters:

flags - the meter-mod flags

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.3

NullPointerException - if flags is null

meterId

public OfmMutableMeterMod meterId(MeterId meterId)

Sets the meter id; Since 1.3.

Parameters:

meterId - the meter id

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.3

NullPointerException - if meterId is null

addBand

public OfmMutableMeterMod addBand(MeterBand band)

Adds a meter band to this meter-mod message; Since 1.3.

Parameters:

band - the meter band to add

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.3

NullPointerException - if band is null