com.h3c.of.lib.msg

Class OfmMutableMultipartRequest

java.lang.Object

com.h3c.nbio.AbstractMessage

com.h3c.of.lib.msg.OpenflowMessage

com.h3c.of.lib.msg.OfmMultipartRequest

com.h3c.of.lib.msg.OfmMutableMultipartRequest

All Implemented Interfaces:

Message, MutableMessage, MutableObject, Structure

public class OfmMutableMultipartRequest
extends OfmMultipartRequest
implements MutableMessage

Mutable subclass of OfmMultipartRequest.

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
OfmMutableMultipartRequest	body(MultipartBody body) Sets the body of this multipart request; Since 1.0.
void	clearXid() Clears the transaction ID field of this message (sets it to 0).
OfmMutableMultipartRequest	setMoreFlag() Sets the REQUEST_MORE flag.
OpenflowMessage	toImmutable() Returns an immutable instance of this message.
String	toString()
OfmMutableMultipartRequest	type(MultipartType type) Sets the type of this multipart request; Since 1.0.
boolean	writable() Returns true if this mutable object is still writable.

Methods inherited from class com.h3c.of.lib.msg.OfmMultipartRequest

getBody, getFlags, getMultipartType, hasMore, toDebugString, validate

Methods inherited from class com.h3c.of.lib.msg.OpenflowMessage

decodeHeader, getType, getVersion, getXid, hex, hex, length

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 OfmMultipartRequest

type

public OfmMutableMultipartRequest type(MultipartType type)

Sets the type of this multipart request; Since 1.0.

This method should only be used for request types that have no corresponding body. For those requests that have a body, use body(MultipartBody) instead.

Parameters:

type - the multipart type for this request

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if type is null

IllegalArgumentException - if the type requires a body

See Also:

body(MultipartBody)

body

public OfmMutableMultipartRequest body(MultipartBody body)

Sets the body of this multipart request; Since 1.0.

This method should only be used for request types that have a body. For those requests that do not have a body, use type(MultipartType) instead.

Parameters:

body - the multipart body for this request

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable

NullPointerException - if body is null

VersionMismatchException - if the body is not the same version as this instance

See Also:

type(MultipartType)

setMoreFlag

public OfmMutableMultipartRequest setMoreFlag()

Sets the REQUEST_MORE flag.

The presence of this flag indicates to the receiver that more (related) multipart-request messages are on their way; Only the last request in such a sequence should have this flag false (cleared).

The default setting for this flag is false; calling this method will latch the flag to true.

Returns:

self, for chaining

Throws:

InvalidMutableException - if this instance is no longer writable