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

Class InternalTunnelBuilder

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

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

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

    • Constructor Detail

      • InternalTunnelBuilder

        public InternalTunnelBuilder()

      • InternalTunnelBuilder

        public InternalTunnelBuilder​(InternalTunnel base)

    • Method Detail

      • getDestinationDPN

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

      • getSourceDPN

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

      • getTransportType

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

      • getTunnelInterfaceNames

        public java.util.List<java.lang.String> getTunnelInterfaceNames()

      • augmentation

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

      • setDestinationDPN

        public InternalTunnelBuilder setDestinationDPN​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setDestinationDPN

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

      • setSourceDPN

        public InternalTunnelBuilder setSourceDPN​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setSourceDPN

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

      • setTunnelInterfaceNames

        public InternalTunnelBuilder setTunnelInterfaceNames​(java.util.List<java.lang.String> values)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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