Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state

Class StateTunnelListBuilder

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

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

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

    • Constructor Detail

      • StateTunnelListBuilder

        public StateTunnelListBuilder()

      • StateTunnelListBuilder

        public StateTunnelListBuilder​(StateTunnelList base)

    • Method Detail

      • getDstInfo

        public DstInfo getDstInfo()

      • getIfIndex

        public org.opendaylight.yangtools.yang.common.Uint16 getIfIndex()

      • getPortNumber

        public java.lang.String getPortNumber()

      • getSrcInfo

        public SrcInfo getSrcInfo()

      • getTransportType

        public java.lang.Class<? extends TunnelTypeBase> getTransportType()

      • getTunnelInterfaceName

        public java.lang.String getTunnelInterfaceName()

      • isTunnelState

        public java.lang.Boolean isTunnelState()

      • augmentation

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

      • setIfIndex

        public StateTunnelListBuilder setIfIndex​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setIfIndex

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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