com.hp.of.lib.msg

Class OfmMutablePortMod

java.lang.Object

com.hp.nbio.AbstractMessage

com.hp.of.lib.msg.OpenflowMessage

com.hp.of.lib.msg.OfmPortMod

com.hp.of.lib.msg.OfmMutablePortMod

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutablePortMod
extends OfmPortMod
implements MutableMessage

Mutable subclass of OfmPortMod.

Author:

Simon Hunt

Field Summary

Fields inherited from class com.hp.nbio.AbstractMessage

length

Method Summary

Methods

Modifier and Type	Method and Description
OfmMutablePortMod	advertise(Set<PortFeature> features) Sets the features of this port to advertise; Since 1.0.
void	clearXid() Clears the transaction ID field of this message (sets it to 0).
OfmMutablePortMod	config(Set<PortConfig> flags) Sets the configuration flags to apply; Since 1.0.
OfmMutablePortMod	configMask(Set<PortConfig> mask) Sets the configuration flags mask to apply; Since 1.0.
OfmMutablePortMod	hwAddress(MacAddress hwAddress) Sets the hardware address to sanity check against; Since 1.0.
OfmMutablePortMod	port(BigPortNumber port) Sets the id of the port to be modified; Since 1.0.
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.OfmPortMod

getAdvertise, getConfig, getConfigMask, getHwAddress, getPort, 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 OfmPortMod

port

public OfmMutablePortMod port(BigPortNumber port)

Sets the id of the port to be modified; Since 1.0.

Note that in 1.0, port numbers are u16.

Parameters:

port - the port number

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if port is null

IllegalArgumentException - if the port number is invalid

hwAddress

public OfmMutablePortMod hwAddress(MacAddress hwAddress)

Sets the hardware address to sanity check against; Since 1.0.

The hardware address is not configurable. This is used to sanity-check the request, so it must be the same as returned in a Port structure.

Parameters:

hwAddress - the hardware address

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if port is null

config

public OfmMutablePortMod config(Set<PortConfig> flags)

Sets the configuration flags to apply; Since 1.0.

Parameters:

flags - the configuration flags

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if flags is null

configMask

public OfmMutablePortMod configMask(Set<PortConfig> mask)

Sets the configuration flags mask to apply; Since 1.0. The flags in the mask select which bits in the config field to change. May be null.

Parameters:

mask - the configuration flags mask

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

advertise

public OfmMutablePortMod advertise(Set<PortFeature> features)

Sets the features of this port to advertise; Since 1.0. May be null.

Parameters:

features - the port features to advertise

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable