com.hp.of.lib.mp

Class MBodyGroupDescStats

java.lang.Object

com.hp.of.lib.OpenflowStructure

com.hp.of.lib.mp.MBodyGroupDescStats

All Implemented Interfaces:

MultipartBody, Structure

Direct Known Subclasses:

MBodyMutableGroupDescStats

public class MBodyGroupDescStats
extends OpenflowStructure
implements MultipartBody

Represents a group description; part of a reply to a group-description request multipart message; since 1.1.

Author:

Prashant Nayak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MBodyGroupDescStats.Array Represents an array of group description elements.
static class	MBodyGroupDescStats.MutableArray A mutable array of group description elements.

Field Summary

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

parseErrorCause, version

Constructor Summary

Constructors

Constructor and Description
MBodyGroupDescStats(ProtocolVersion pv) Constructs a multipart body GROUP_DESC type.

Method Summary

Methods

Modifier and Type	Method and Description
List<Bucket>	getBuckets() Returns the list of buckets for this group; Since 1.1.
GroupId	getGroupId() Returns the group ID; Since 1.1.
int	getTotalLength() Returns the total length of the body, in bytes.
GroupType	getType() Returns the group type; Since 1.1.
String	toDebugString() Returns a string representation useful for debugging.
String	toDebugString(int indent) Returns a multi-line representation of this group desc stats object.
String	toString()
void	validate() Validates this structure for completeness and throws an exception if the structure is considered "not complete".

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

Constructor Detail

MBodyGroupDescStats

public MBodyGroupDescStats(ProtocolVersion pv)

Constructs a multipart body GROUP_DESC type.

Parameters:

pv - the protocol version

Method Detail

getTotalLength

public int getTotalLength()

Description copied from interface: MultipartBody

Returns the total length of the body, in bytes.

Specified by:

getTotalLength in interface MultipartBody

Returns:

the total length of the body

toString

public String toString()

Overrides:

toString in class OpenflowStructure

toDebugString

public String toDebugString()

Description copied from class: OpenflowStructure

Returns a string representation useful for debugging. This default implementation delegates to OpenflowStructure.toString(), but subclasses are free to override this behavior.

Specified by:

toDebugString in interface Structure

Overrides:

toDebugString in class OpenflowStructure

Returns:

a (possibly multi-line) string representation of this message

validate

public void validate()
              throws IncompleteStructureException

Description copied from class: OpenflowStructure

Validates this structure for completeness and throws an exception if the structure is considered "not complete".

This default implementation does nothing, i.e. default behavior is that structures are considered complete.

Subclasses should override this method to check that mandatory fields or other internal state is present, throwing an exception if it is not.

Specified by:

validate in interface MultipartBody

Overrides:

validate in class OpenflowStructure

Throws:

IncompleteStructureException - if the structure is not complete

toDebugString

public String toDebugString(int indent)

Returns a multi-line representation of this group desc stats object.

Parameters:

indent - the additional indent (number of spaces)

Returns:

a multi-line representation

getType

public GroupType getType()

Returns the group type; Since 1.1.

Returns:

the group type

getGroupId

public GroupId getGroupId()

Returns the group ID; Since 1.1.

Returns:

the group ID

getBuckets

public List<Bucket> getBuckets()

Returns the list of buckets for this group; Since 1.1.

Returns:

the list of bucket