Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop

Class Ipv6NextHopCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.Ipv6NextHopCaseBuilder
@Generated("mdsal-binding-generator") public class Ipv6NextHopCaseBuilder extends Object
Class that builds Ipv6NextHopCase 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: 

   
     Ipv6NextHopCase createIpv6NextHopCase(int fooXyzzy, int barBaz) {
         return new Ipv6NextHopCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv6NextHopCaseBuilder

      public Ipv6NextHopCaseBuilder()
      Construct an empty builder.

    • Ipv6NextHopCaseBuilder

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

  • Method Details

    • getIpv6NextHop

      public Ipv6NextHop getIpv6NextHop()
      Return current value associated with the property corresponding to Ipv6NextHopCase.getIpv6NextHop().
      Returns:
      current value

    • augmentation

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

    • setIpv6NextHop

      public Ipv6NextHopCaseBuilder setIpv6NextHop(Ipv6NextHop value)
      Set the property corresponding to Ipv6NextHopCase.getIpv6NextHop() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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