com.hp.of.lib.msg

Class OfmMutablePortStatus

java.lang.Object

com.hp.nbio.AbstractMessage

com.hp.of.lib.msg.OpenflowMessage

com.hp.of.lib.msg.OfmPortStatus

com.hp.of.lib.msg.OfmMutablePortStatus

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutablePortStatus
extends OfmPortStatus
implements MutableMessage

Mutable subclass of OfmPortStatus.

Author:

Radhika Hegde

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).
OfmMutablePortStatus	port(Port port) Sets the port whose status changed; Since 1.0.
OfmMutablePortStatus	reason(PortReason reason) Sets the reason for port status change; 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.OfmPortStatus

getPort, getReason, 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 OfmPortStatus

reason

public OfmMutablePortStatus reason(PortReason reason)

Sets the reason for port status change; Since 1.0.

Parameters:

reason - for the status change

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if reason is null

port

public OfmMutablePortStatus port(Port port)
                          throws IncompleteStructureException

Sets the port whose status changed; Since 1.0.

Parameters:

port - the physical port

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if port is null

IllegalArgumentException - if port is mutable

IncompleteStructureException - if port structure is incomplete