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

Class ActionBuilder

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

   
     Action createAction(int fooXyzzy, int barBaz) {
         return new ActionBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ActionBuilder

      public ActionBuilder()
      Construct an empty builder.

    • ActionBuilder

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

    • ActionBuilder

      public ActionBuilder(Action arg)
      Construct a new builder initialized from specified Action.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.Action from which the builder should be initialized

    • ActionBuilder

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

    • key

      public ActionKey key()
      Return current value associated with the property corresponding to Action.key().
      Returns:
      current value

    • getAction

      public Action getAction()
      Return current value associated with the property corresponding to Action.getAction().
      Returns:
      current value

    • getOrder

      public Integer getOrder()
      Return current value associated with the property corresponding to Ordered.getOrder().
      Returns:
      current value

    • augmentation

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

    • withKey

      public ActionBuilder withKey(ActionKey key)
      Set the key value corresponding to Action.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAction

      public ActionBuilder setAction(Action value)
      Set the property corresponding to Action.getAction() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOrder

      public ActionBuilder setOrder(Integer value)
      Set the property corresponding to Ordered.getOrder() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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