Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.key.object.path.key

Class PathKeysBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.key.object.path.key.PathKeysBuilder
@Generated("mdsal-binding-generator") public class PathKeysBuilder extends Object
Class that builds PathKeys 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: 

   
     PathKeys createPathKeys(int fooXyzzy, int barBaz) {
         return new PathKeysBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PathKeysBuilder

      public PathKeysBuilder()
      Construct an empty builder.

    • PathKeysBuilder

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

    • PathKeysBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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

    • getLoose

      public Boolean getLoose()
      Return current value associated with the property corresponding to PathKeys.getLoose().
      Returns:
      current value

    • getPathKey

      public PathKey getPathKey()
      Return current value associated with the property corresponding to PathKeySubobject.getPathKey().
      Returns:
      current value

    • getPceId

      public PceId getPceId()
      Return current value associated with the property corresponding to PathKeySubobject.getPceId().
      Returns:
      current value

    • augmentation

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

    • setLoose

      public PathKeysBuilder setLoose(Boolean value)
      Set the property corresponding to PathKeys.getLoose() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPathKey

      public PathKeysBuilder setPathKey(PathKey value)
      Set the property corresponding to PathKeySubobject.getPathKey() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPceId

      public PathKeysBuilder setPceId(PceId value)
      Set the property corresponding to PathKeySubobject.getPceId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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