Package org.opendaylight.yang.gen.v1.urn.opendaylight.bulk.flow.service.rev150608

Class FlowRpcAddMultipleInputBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.bulk.flow.service.rev150608.FlowRpcAddMultipleInputBuilder
@Generated("mdsal-binding-generator") public class FlowRpcAddMultipleInputBuilder extends Object
Class that builds FlowRpcAddMultipleInput 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: 

   
     FlowRpcAddMultipleInput createFlowRpcAddMultipleInput(int fooXyzzy, int barBaz) {
         return new FlowRpcAddMultipleInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FlowRpcAddMultipleInputBuilder

      public FlowRpcAddMultipleInputBuilder()
      Construct an empty builder.

    • FlowRpcAddMultipleInputBuilder

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

  • Method Details

    • getFlowCount

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

    • getRpcBatchSize

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

    • augmentation

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

    • setFlowCount

      public FlowRpcAddMultipleInputBuilder setFlowCount(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowRpcAddMultipleInput.getFlowCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRpcBatchSize

      public FlowRpcAddMultipleInputBuilder setRpcBatchSize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowRpcAddMultipleInput.getRpcBatchSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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