Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action

Class OutputActionCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCaseBuilder
@Generated("mdsal-binding-generator") public class OutputActionCaseBuilder extends Object
Class that builds OutputActionCase 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: 

   
     OutputActionCase createOutputActionCase(int fooXyzzy, int barBaz) {
         return new OutputActionCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • OutputActionCaseBuilder

      public OutputActionCaseBuilder()
      Construct an empty builder.

    • OutputActionCaseBuilder

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

  • Method Details

    • getOutputAction

      public OutputAction getOutputAction()
      Return current value associated with the property corresponding to OutputActionCase.getOutputAction().
      Returns:
      current value

    • augmentation

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

    • setOutputAction

      public OutputActionCaseBuilder setOutputAction(OutputAction value)
      Set the property corresponding to OutputActionCase.getOutputAction() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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