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

Class FlowTestInputBuilder

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

   
     FlowTestInput createFlowTestInput(int fooXyzzy, int barBaz) {
         return new FlowTestInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FlowTestInputBuilder

      public FlowTestInputBuilder()
      Construct an empty builder.

    • FlowTestInputBuilder

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

  • Method Details

    • getBatchSize

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

    • getCreateParents

      public Boolean getCreateParents()
      Return current value associated with the property corresponding to FlowTestInput.getCreateParents().
      Returns:
      current value

    • getDpnCount

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

    • getEndTableId

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

    • getFlowsPerDpn

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

    • getIsAdd

      public Boolean getIsAdd()
      Return current value associated with the property corresponding to FlowTestInput.getIsAdd().
      Returns:
      current value

    • getSeq

      public Boolean getSeq()
      Return current value associated with the property corresponding to FlowTestInput.getSeq().
      Returns:
      current value

    • getSleepAfter

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

    • getSleepFor

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

    • getStartTableId

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

    • getTxChain

      public Boolean getTxChain()
      Return current value associated with the property corresponding to FlowTestInput.getTxChain().
      Returns:
      current value

    • augmentation

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

    • setBatchSize

      public FlowTestInputBuilder setBatchSize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowTestInput.getBatchSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCreateParents

      public FlowTestInputBuilder setCreateParents(Boolean value)
      Set the property corresponding to FlowTestInput.getCreateParents() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDpnCount

      public FlowTestInputBuilder setDpnCount(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowTestInput.getDpnCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEndTableId

      public FlowTestInputBuilder setEndTableId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowTestInput.getEndTableId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFlowsPerDpn

      public FlowTestInputBuilder setFlowsPerDpn(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowTestInput.getFlowsPerDpn() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIsAdd

      public FlowTestInputBuilder setIsAdd(Boolean value)
      Set the property corresponding to FlowTestInput.getIsAdd() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSeq

      public FlowTestInputBuilder setSeq(Boolean value)
      Set the property corresponding to FlowTestInput.getSeq() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSleepAfter

      public FlowTestInputBuilder setSleepAfter(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowTestInput.getSleepAfter() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSleepFor

      public FlowTestInputBuilder setSleepFor(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowTestInput.getSleepFor() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStartTableId

      public FlowTestInputBuilder setStartTableId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowTestInput.getStartTableId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTxChain

      public FlowTestInputBuilder setTxChain(Boolean value)
      Set the property corresponding to FlowTestInput.getTxChain() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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