Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family

Class P2mpIpv6CaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.P2mpIpv6CaseBuilder
@Generated("mdsal-binding-generator") public class P2mpIpv6CaseBuilder extends Object
Class that builds P2mpIpv6Case 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: 

   
     P2mpIpv6Case createP2mpIpv6Case(int fooXyzzy, int barBaz) {
         return new P2mpIpv6CaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • P2mpIpv6CaseBuilder

      public P2mpIpv6CaseBuilder()
      Construct an empty builder.

    • P2mpIpv6CaseBuilder

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

  • Method Details

    • getP2mpIpv6

      public P2mpIpv6 getP2mpIpv6()
      Return current value associated with the property corresponding to P2mpIpv6Case.getP2mpIpv6().
      Returns:
      current value

    • augmentation

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

    • setP2mpIpv6

      public P2mpIpv6CaseBuilder setP2mpIpv6(P2mpIpv6 value)
      Set the property corresponding to P2mpIpv6Case.getP2mpIpv6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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