Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone

Class VtepsBuilder

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

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

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

    • Constructor Detail

      • VtepsBuilder

        public VtepsBuilder()

      • VtepsBuilder

        public VtepsBuilder​(Vteps base)

    • Method Detail

      • getDpnId

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

      • getIpAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()

      • getOptionTunnelTos

        public java.lang.String getOptionTunnelTos()

      • isOptionOfTunnel

        public java.lang.Boolean isOptionOfTunnel()

      • augmentation

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

      • setDpnId

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

      • setDpnId

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

      • setIpAddress

        public VtepsBuilder setIpAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setOptionTunnelTos

        public VtepsBuilder setOptionTunnelTos​(java.lang.String value)

      • setOptionOfTunnel

        public VtepsBuilder setOptionOfTunnel​(java.lang.Boolean value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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