com.hp.of.lib.msg

Class MutableQueue

java.lang.Object

com.hp.of.lib.OpenflowStructure

com.hp.of.lib.msg.Queue

com.hp.of.lib.msg.MutableQueue

All Implemented Interfaces:

MutableObject, MutableStructure, Structure

public class MutableQueue
extends Queue
implements MutableStructure

Mutable subclass of Queue.

Author:

Simon Hunt

Field Summary

Fields inherited from class com.hp.of.lib.OpenflowStructure

parseErrorCause, version

Method Summary

Methods

Modifier and Type	Method and Description
MutableQueue	addProperty(QueueProperty property) Adds a property to this queue; Since 1.0.
MutableQueue	id(QueueId id) Sets the id of this queue; Since 1.0.
MutableQueue	port(BigPortNumber port) Sets the port number for this queue; Since 1.2.
OpenflowStructure	toImmutable() Returns an immutable instance of this structure.
String	toString()
boolean	writable() Returns true if this mutable object is still writable.

Methods inherited from class com.hp.of.lib.msg.Queue

getId, getPort, getProps, validate

Methods inherited from class com.hp.of.lib.OpenflowStructure

getVersion, hex, hex, incomplete, parseErrorCause, toDebugString

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.Structure

getVersion, toDebugString

Method Detail

toImmutable

public OpenflowStructure toImmutable()

Description copied from interface: MutableStructure

Returns an immutable instance of this structure. In essence, converts this structure to be read-only.

It is expected that the reference to this mutable structure will be dropped. Note that all method calls invoked on a MutableStructure after toImmutable() has been invoked will result in an InvalidMutableException being thrown.

Specified by:

toImmutable in interface MutableStructure

Returns:

an immutable instance of this structure.

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 Queue

id

public MutableQueue id(QueueId id)

Sets the id of this queue; Since 1.0.

Parameters:

id - the queue id

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if id is null

port

public MutableQueue port(BigPortNumber port)

Sets the port number for this queue; Since 1.2.

Parameters:

port - the port number

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

VersionMismatchException - if version is < 1.2

NullPointerException - if port is null

addProperty

public MutableQueue addProperty(QueueProperty property)

Adds a property to this queue; Since 1.0.

Parameters:

property - the property to add

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if property is null

VersionMismatchException - if property is not supported for the given version