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

Class SrcBuilder

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

   
     Src createSrc(int fooXyzzy, int barBaz) {
         return new SrcBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrcBuilder

      public SrcBuilder()
      Construct an empty builder.

    • SrcBuilder

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

    • SrcBuilder

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

    • SrcBuilder

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

    • empty

      public static @NonNull Src empty()
      Get empty instance of Src.
      Returns:
      An empty Src

    • getEnd

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

    • getSrcChoice

      public SrcChoice getSrcChoice()
      Return current value associated with the property corresponding to SrcChoiceGrouping.getSrcChoice().
      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<Src>> 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

    • setEnd

      public SrcBuilder 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

    • setSrcChoice

      public SrcBuilder setSrcChoice(SrcChoice value)
      Set the property corresponding to SrcChoiceGrouping.getSrcChoice() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStart

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