com.h3c.of.lib.mp

## Class MBodyMutableQueueStatsRequest

- java.lang.Object
- - com.h3c.of.lib.OpenflowStructure
  - - com.h3c.of.lib.mp.MBodyQueueStatsRequest
    - - com.h3c.of.lib.mp.MBodyMutableQueueStatsRequest

- All Implemented Interfaces:
    MultipartBody, MutableObject, MutableStructure, Structure

      public class MBodyMutableQueueStatsRequest
      extends MBodyQueueStatsRequest
      implements MutableStructure

  Mutable subclass of `MBodyQueueStatsRequest`.

- - ### Field Summary

    - ### Fields inherited from class com.h3c.of.lib.OpenflowStructure

      `version`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MBodyMutableQueueStatsRequest(ProtocolVersion pv)` Constructs a mutable multipart body QUEUE request type.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `MBodyMutableQueueStatsRequest` | `port(BigPortNumber port)` Sets the port number for which statistics are requested; Since 1.0.
    `MBodyMutableQueueStatsRequest` | `queueId(QueueId queueId)` Sets the ID of the queue to read; 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.h3c.of.lib.mp.MBodyQueueStatsRequest

      `getPort, getQueueId, getTotalLength, toDebugString, validate`

    - ### Methods inherited from class com.h3c.of.lib.OpenflowStructure

      `getVersion, hex, hex`

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

      `getVersion, toDebugString`

- - ### Constructor Detail

    - #### MBodyMutableQueueStatsRequest

          public MBodyMutableQueueStatsRequest(ProtocolVersion pv)

      Constructs a mutable multipart body QUEUE request type.

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

      - port number: `Port.ANY`
      - queue id : `QueueId.ALL`

      Parameters:
        `pv` - the protocol version

  - ### Method Detail

    - #### 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

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

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `MBodyQueueStatsRequest`

    - #### port

          public MBodyMutableQueueStatsRequest port(BigPortNumber port)

      Sets the port number for which statistics are requested; Since 1.0. A value of `Port.ANY` indicates no restriction.

      Note that in 1.0, port numbers are u16.

      Parameters:
        `port` - the 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

    - #### queueId

          public MBodyMutableQueueStatsRequest queueId(QueueId queueId)

      Sets the ID of the queue to read; Since 1.0.

      A value of `QueueId.ALL` indicates all queues configured at the specified port.

      Parameters:
        `queueId` - the queue ID
      Returns:
        self, for chaining
      Throws:
        `InvalidMutableException` - if this instance is no longer writable
        `NullPointerException` - if queueId is null

Copyright © 2014. All Rights Reserved.