Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.p2mp.te.lsp.rev181109.p2mp.pce.capability.tlv

Class P2mpPceCapabilityBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.p2mp.te.lsp.rev181109.p2mp.pce.capability.tlv.P2mpPceCapabilityBuilder
@Generated("mdsal-binding-generator") public class P2mpPceCapabilityBuilder extends Object
Class that builds P2mpPceCapability 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: 

   
     P2mpPceCapability createP2mpPceCapability(int fooXyzzy, int barBaz) {
         return new P2mpPceCapabilityBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • P2mpPceCapabilityBuilder

      public P2mpPceCapabilityBuilder()
      Construct an empty builder.

    • P2mpPceCapabilityBuilder

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

    • P2mpPceCapabilityBuilder

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

    • augmentation

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