Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues

Class QueueBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.QueueBuilder
@Generated("mdsal-binding-generator") public class QueueBuilder extends Object
Class that builds Queue instances. Overall design of the class is that of a fluent interface, where method chaining is used.

In general, this class is supposed to be used like this template: 

   
     Queue createQueue(int fooXyzzy, int barBaz) {
         return new QueueBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Queue, as instances can be freely passed around without worrying about synchronization issues.

As a side note: method chaining results in:

  • very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is on the stack, so further method invocations just need to fill method arguments for the next method invocation, which is terminated by build(), which is then returned from the method
  • better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
  • better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
See Also:

  • Constructor Details

    • QueueBuilder

      public QueueBuilder()
      Construct an empty builder.

    • QueueBuilder

      public QueueBuilder(QueuePacket arg)
      Construct a new builder initialized from specified QueuePacket.
      Parameters:
      arg - QueuePacket from which the builder should be initialized

    • QueueBuilder

      public QueueBuilder(CommonQueue arg)
      Construct a new builder initialized from specified CommonQueue.
      Parameters:
      arg - CommonQueue from which the builder should be initialized

    • QueueBuilder

      public QueueBuilder(Queue base)
      Construct a builder initialized with state from specified Queue.
      Parameters:
      base - Queue from which the builder should be initialized

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • key

      public QueueKey key()
      Return current value associated with the property corresponding to Queue.key().
      Returns:
      current value

    • getPort

      public org.opendaylight.yangtools.yang.common.Uint32 getPort()
      Return current value associated with the property corresponding to QueuePacket.getPort().
      Returns:
      current value

    • getProperty

      public org.opendaylight.yangtools.yang.common.Uint16 getProperty()
      Return current value associated with the property corresponding to CommonQueue.getProperty().
      Returns:
      current value

    • getQueueId

      public QueueId getQueueId()
      Return current value associated with the property corresponding to QueuePacket.getQueueId().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • withKey

      public QueueBuilder withKey(QueueKey key)
      Set the key value corresponding to Queue.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setPort

      public QueueBuilder setPort(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to QueuePacket.getPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProperty

      public QueueBuilder setProperty(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to CommonQueue.getProperty() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setQueueId

      public QueueBuilder setQueueId(QueueId value)
      Set the property corresponding to QueuePacket.getQueueId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public QueueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Queue> augmentation)
      Add an augmentation to this builder's product.
      Parameters:
      augmentation - augmentation to be added
      Returns:
      this builder
      Throws:
      NullPointerException - if augmentation is null

    • removeAugmentation

      public QueueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      Parameters:
      augmentationType - augmentation type to be removed
      Returns:
      this builder

    • build

      public @NonNull Queue build()
      A new Queue instance.
      Returns:
      A new Queue instance.