Class LabelRouteInfoBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<LabelRouteInfo>, org.opendaylight.yangtools.concepts.CheckedBuilder<LabelRouteInfo,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class LabelRouteInfoBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<LabelRouteInfo>
    Class that builds LabelRouteInfoBuilder 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:

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

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

      • LabelRouteInfoBuilder

        public LabelRouteInfoBuilder()
      • LabelRouteInfoBuilder

        public LabelRouteInfoBuilder​(LabelRouteInfo base)
    • Method Detail

      • getDpnId

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

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

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

        public java.util.List<java.lang.String> getNextHopIpList()
      • getParentVpnRd

        public java.lang.String getParentVpnRd()
      • getParentVpnid

        public org.opendaylight.yangtools.yang.common.Uint32 getParentVpnid()
      • getPrefix

        public java.lang.String getPrefix()
      • getVpnInstanceList

        public java.util.List<java.lang.String> getVpnInstanceList()
      • getVpnInterfaceName

        public java.lang.String getVpnInterfaceName()
      • isIsSubnetRoute

        public java.lang.Boolean isIsSubnetRoute()
      • augmentation

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

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

        @Deprecated(forRemoval=true)
        public LabelRouteInfoBuilder 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
      • setElanTag

        public LabelRouteInfoBuilder setElanTag​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setElanTag

        @Deprecated(forRemoval=true)
        public LabelRouteInfoBuilder 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
      • setLabel

        public LabelRouteInfoBuilder setLabel​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setLabel

        @Deprecated(forRemoval=true)
        public LabelRouteInfoBuilder 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
      • setNextHopIpList

        public LabelRouteInfoBuilder setNextHopIpList​(java.util.List<java.lang.String> values)
      • setParentVpnid

        public LabelRouteInfoBuilder setParentVpnid​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setParentVpnid

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

        public LabelRouteInfoBuilder setVpnInstanceList​(java.util.List<java.lang.String> values)
      • addAugmentation

        public LabelRouteInfoBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabelRouteInfo>> augmentationType,
                                                     org.opendaylight.yangtools.yang.binding.Augmentation<LabelRouteInfo> augmentationValue)
      • removeAugmentation

        public LabelRouteInfoBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabelRouteInfo>> augmentationType)
      • build

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