Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.nx.reg.load

Class DstBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.nx.reg.load.DstBuilder
@Generated("mdsal-binding-generator") public class DstBuilder extends Object
Class that builds Dst 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: 

   
     Dst createDst(int fooXyzzy, int barBaz) {
         return new DstBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • DstBuilder

      public DstBuilder()
      Construct an empty builder.

    • DstBuilder

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

    • DstBuilder

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

    • DstBuilder

      public DstBuilder(Dst base)
      Construct a builder initialized with state from specified Dst.
      Parameters:
      base - Dst 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

    • getDstChoice

      public DstChoice getDstChoice()
      Return current value associated with the property corresponding to DstChoiceGrouping.getDstChoice().
      Returns:
      current value

    • getEnd

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

    • getStart

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

    • augmentation

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

    • setDstChoice

      public DstBuilder setDstChoice(DstChoice value)
      Set the property corresponding to DstChoiceGrouping.getDstChoice() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEnd

      public DstBuilder setEnd(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to RangeGrouping.getEnd() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStart

      public DstBuilder setStart(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to RangeGrouping.getStart() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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