Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface

Class VxlanGpeBuilder

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

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

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

    • Constructor Detail

      • VxlanGpeBuilder

        public VxlanGpeBuilder()

      • VxlanGpeBuilder

        public VxlanGpeBuilder​(VxlanGpe base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VxlanGpeBaseAttributes
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getDecapVrfId

        public org.opendaylight.yangtools.yang.common.Uint32 getDecapVrfId()

      • getEncapVrfId

        public org.opendaylight.yangtools.yang.common.Uint32 getEncapVrfId()

      • getLocal

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

      • getRemote

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

      • augmentation

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

      • setDecapVrfId

        public VxlanGpeBuilder setDecapVrfId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDecapVrfId

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

      • setEncapVrfId

        public VxlanGpeBuilder setEncapVrfId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setEncapVrfId

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

      • setLocal

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

      • setRemote

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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