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

Class Ipv6NextHopBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Ipv6NextHop>, org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6NextHop,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class Ipv6NextHopBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Ipv6NextHop>
    Class that builds Ipv6NextHop 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: 

       
     Ipv6NextHop createIpv6NextHop(int fooXyzzy, int barBaz) {
         return new Ipv6NextHopBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • Ipv6NextHopBuilder

        public Ipv6NextHopBuilder()

      • Ipv6NextHopBuilder

        public Ipv6NextHopBuilder​(Ipv6NextHop base)

    • Method Detail

      • getGlobal

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getGlobal()

      • getLinkLocal

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getLinkLocal()

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6NextHop>> E$$ augmentation​(Class<E$$> augmentationType)

      • setGlobal

        public Ipv6NextHopBuilder setGlobal​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)

      • setLinkLocal

        public Ipv6NextHopBuilder setLinkLocal​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)

      • addAugmentation

        public Ipv6NextHopBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6NextHop> 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 Ipv6NextHopBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6NextHop>> 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