Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data

Class SubnetOpDataEntryBuilder

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

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

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

    • Constructor Detail

      • SubnetOpDataEntryBuilder

        public SubnetOpDataEntryBuilder()

      • SubnetOpDataEntryBuilder

        public SubnetOpDataEntryBuilder​(NetworkAttributes arg)

      • SubnetOpDataEntryBuilder

        public SubnetOpDataEntryBuilder​(SubnetOpDataEntry base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getElanTag

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

      • getL3vni

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

      • getLabel

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

      • getLastAdvState

        public TaskState getLastAdvState()

      • getNetworkId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()

      • getNhDpnId

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

      • getRouteAdvState

        public TaskState getRouteAdvState()

      • getSegmentationId

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

      • getSubnetCidr

        public java.lang.String getSubnetCidr()

      • getSubnetId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSubnetId()

      • getSubnetToDpn

        public java.util.List<SubnetToDpn> getSubnetToDpn()

      • getVpnName

        public java.lang.String getVpnName()

      • getVrfId

        public java.lang.String getVrfId()

      • isExternal

        public java.lang.Boolean isExternal()

      • augmentation

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

      • setElanTag

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

      • setL3vni

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

      • setLabel

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

      • setNetworkId

        public SubnetOpDataEntryBuilder setNetworkId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setNhDpnId

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

      • setSegmentationId

        public SubnetOpDataEntryBuilder setSegmentationId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setSegmentationId

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

      • setSubnetId

        public SubnetOpDataEntryBuilder setSubnetId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • build

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