Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction

Class GoToTableCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.GoToTableCaseBuilder
@Generated("mdsal-binding-generator") public class GoToTableCaseBuilder extends Object
Class that builds GoToTableCase 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: 

   
     GoToTableCase createGoToTableCase(int fooXyzzy, int barBaz) {
         return new GoToTableCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • GoToTableCaseBuilder

      public GoToTableCaseBuilder()
      Construct an empty builder.

    • GoToTableCaseBuilder

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

  • Method Details

    • getGoToTable

      public GoToTable getGoToTable()
      Return current value associated with the property corresponding to GoToTableCase.getGoToTable().
      Returns:
      current value

    • augmentation

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

    • setGoToTable

      public GoToTableCaseBuilder setGoToTable(GoToTable value)
      Set the property corresponding to GoToTableCase.getGoToTable() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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