com.hp.of.lib.mp

Class MBodyMutablePortStatsRequest

java.lang.Object

com.hp.of.lib.OpenflowStructure

com.hp.of.lib.mp.MBodyPortStatsRequest

com.hp.of.lib.mp.MBodyMutablePortStatsRequest

All Implemented Interfaces:

MultipartBody, MutableObject, MutableStructure, Structure

public class MBodyMutablePortStatsRequest
extends MBodyPortStatsRequest
implements MutableStructure

Mutable subclass of MBodyPortStatsRequest.

Author:

Pramod Shanbhag

Field Summary

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

parseErrorCause, version

Constructor Summary

Constructors

Constructor and Description
MBodyMutablePortStatsRequest(ProtocolVersion pv) Constructs a mutable multipart body PORT_STATS request type.

Method Summary

Methods

Modifier and Type	Method and Description
MBodyMutablePortStatsRequest	port(BigPortNumber port) Sets the port in the port stats request; Since 1.0.
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.mp.MBodyPortStatsRequest

getPort, getTotalLength, toDebugString, validate

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

getVersion, hex, hex, incomplete, parseErrorCause

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

Constructor Detail

MBodyMutablePortStatsRequest

public MBodyMutablePortStatsRequest(ProtocolVersion pv)

Constructs a mutable multipart body PORT_STATS request type.

Note that a freshly constructed instance has the following default value:

• port : Port.ANY

Parameters:

pv - the protocol version

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 MBodyPortStatsRequest

port

public MBodyMutablePortStatsRequest port(BigPortNumber port)

Sets the port in the port stats request; Since 1.0. A value of Port.ANY indicates stats requested for all ports.

Note that in 1.0, port numbers are u16.

Parameters:

port - the requested port

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