Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match

Class TunnelBuilder

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

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

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

    • Constructor Detail

      • TunnelBuilder

        public TunnelBuilder()

      • TunnelBuilder

        public TunnelBuilder​(Tunnel base)

    • Method Detail

      • getTunnelId

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

      • getTunnelMask

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

      • augmentation

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

      • setTunnelId

        public TunnelBuilder setTunnelId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setTunnelId

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

      • setTunnelMask

        public TunnelBuilder setTunnelMask​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setTunnelMask

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

      • addAugmentation

        public TunnelBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel>> augmentationType,
                                     org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel> augmentationValue)

      • removeAugmentation

        public TunnelBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel>> augmentationType)

      • build

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