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

Class ReadFlowTestInputBuilder

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

   
     ReadFlowTestInput createReadFlowTestInput(int fooXyzzy, int barBaz) {
         return new ReadFlowTestInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ReadFlowTestInputBuilder

      public ReadFlowTestInputBuilder()
      Construct an empty builder.

    • ReadFlowTestInputBuilder

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

  • Method Details

    • getDpnCount

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

    • getEndTableId

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

    • getFlowsPerDpn

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

    • getIsConfigDs

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

    • getStartTableId

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

    • getVerbose

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

    • augmentation

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

    • setDpnCount

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

    • setEndTableId

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

    • setFlowsPerDpn

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

    • setIsConfigDs

      public ReadFlowTestInputBuilder setIsConfigDs(Boolean value)
      Set the property corresponding to ReadFlowTestInput.getIsConfigDs() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStartTableId

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

    • setVerbose

      public ReadFlowTestInputBuilder setVerbose(Boolean value)
      Set the property corresponding to ReadFlowTestInput.getVerbose() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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