Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.ports

Class InternalToExternalPortMapBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<InternalToExternalPortMap>, org.opendaylight.yangtools.concepts.CheckedBuilder<InternalToExternalPortMap,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class InternalToExternalPortMapBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<InternalToExternalPortMap>
    Class that builds InternalToExternalPortMapBuilder 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: 

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

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

    • Constructor Detail

      • InternalToExternalPortMapBuilder

        public InternalToExternalPortMapBuilder()

    • Method Detail

      • getExternalId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getExternalId()

      • getExternalIp

        public java.lang.String getExternalIp()

      • getInternalIp

        public java.lang.String getInternalIp()

      • getLabel

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

      • augmentation

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

      • setExternalId

        public InternalToExternalPortMapBuilder setExternalId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setLabel

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

      • addAugmentation

        public InternalToExternalPortMapBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null

      • removeAugmentation

        public InternalToExternalPortMapBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder