Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rpcs.rev160406

Class GetTunnelInterfaceNameInputBuilder

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

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

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

    • Constructor Detail

      • GetTunnelInterfaceNameInputBuilder

        public GetTunnelInterfaceNameInputBuilder()

    • Method Detail

      • getDestinationDpid

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

      • getSourceDpid

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

      • getTunnelType

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

      • augmentation

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

      • setDestinationDpid

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

      • setSourceDpid

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