Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.ensure.lsp.operational.args

Class ArgumentsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.ensure.lsp.operational.args.ArgumentsBuilder
@Generated("mdsal-binding-generator") public class ArgumentsBuilder extends Object
Class that builds Arguments 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: 

   
     Arguments createArguments(int fooXyzzy, int barBaz) {
         return new ArgumentsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ArgumentsBuilder

      public ArgumentsBuilder()
      Construct an empty builder.

    • ArgumentsBuilder

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

  • Method Details

    • empty

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

    • augmentation

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

    • addAugmentation

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