Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class GetQueueConfigInputBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigInputBuilder
@Generated("mdsal-binding-generator") public class GetQueueConfigInputBuilder extends Object
Class that builds GetQueueConfigInput 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: 

   
     GetQueueConfigInput createGetQueueConfigInput(int fooXyzzy, int barBaz) {
         return new GetQueueConfigInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of GetQueueConfigInput, 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

    • GetQueueConfigInputBuilder

      public GetQueueConfigInputBuilder()
      Construct an empty builder.

    • GetQueueConfigInputBuilder

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

    • GetQueueConfigInputBuilder

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

    • GetQueueConfigInputBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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

    • getPort

      public PortNumber getPort()
      Return current value associated with the property corresponding to QueueGetConfigRequest.getPort().
      Returns:
      current value

    • getVersion

      public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
      Return current value associated with the property corresponding to OfHeader.getVersion().
      Returns:
      current value

    • getXid

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<GetQueueConfigInput>> 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

    • setPort

      public GetQueueConfigInputBuilder setPort(PortNumber value)
      Set the property corresponding to QueueGetConfigRequest.getPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public GetQueueConfigInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to OfHeader.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXid

      public GetQueueConfigInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to OfHeader.getXid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public GetQueueConfigInputBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<GetQueueConfigInput> 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 GetQueueConfigInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<GetQueueConfigInput>> 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 GetQueueConfigInput build()
      A new GetQueueConfigInput instance.
      Returns:
      A new GetQueueConfigInput instance.