Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.subobject.nai

Class Ipv6LocalBuilder

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

       
     Ipv6LocalBuilder createTarget(int fooXyzzy, int barBaz) {
         return new Ipv6LocalBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • Ipv6LocalBuilder

        public Ipv6LocalBuilder()

      • Ipv6LocalBuilder

        public Ipv6LocalBuilder​(Ipv6Local base)

    • Method Detail

      • getLocalId

        public org.opendaylight.yangtools.yang.common.Uint32 getLocalId()

      • getLocalIpv6Address

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

      • getRemoteId

        public org.opendaylight.yangtools.yang.common.Uint32 getRemoteId()

      • getRemoteIpv6Address

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

      • augmentation

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

      • setLocalId

        public Ipv6LocalBuilder setLocalId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setLocalId

        @Deprecated(forRemoval=true)
public Ipv6LocalBuilder setLocalId​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setLocalId(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setLocalIpv6Address

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

      • setRemoteId

        public Ipv6LocalBuilder setRemoteId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setRemoteId

        @Deprecated(forRemoval=true)
public Ipv6LocalBuilder setRemoteId​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setRemoteId(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setRemoteIpv6Address

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

      • addAugmentation

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