Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.vpnnexthops

Class VpnNexthopBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<VpnNexthop>, org.opendaylight.yangtools.concepts.CheckedBuilder<VpnNexthop,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class VpnNexthopBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<VpnNexthop>
    Class that builds VpnNexthopBuilder 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: 

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

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

    • Constructor Detail

      • VpnNexthopBuilder

        public VpnNexthopBuilder()

      • VpnNexthopBuilder

        public VpnNexthopBuilder​(VpnNexthop base)

    • Method Detail

      • getDpnId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()

      • getEgressPointer

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

      • getIpAddress

        public java.lang.String getIpAddress()

      • getIpAdjacencies

        public java.util.List<IpAdjacencies> getIpAdjacencies()

      • augmentation

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

      • setDpnId

        public VpnNexthopBuilder setDpnId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setDpnId

        @Deprecated(forRemoval=true)
public VpnNexthopBuilder setDpnId​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setDpnId(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setEgressPointer

        public VpnNexthopBuilder setEgressPointer​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setEgressPointer

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

      • addAugmentation

        public VpnNexthopBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop>> augmentationType,
                                         org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop> augmentationValue)

      • removeAugmentation

        public VpnNexthopBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop>> augmentationType)

      • build

        public VpnNexthop build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<VpnNexthop>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<VpnNexthop,​java.lang.IllegalArgumentException>