Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.intext.ip.map

Class IpMappingBuilder

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

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

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

    • Constructor Detail

      • IpMappingBuilder

        public IpMappingBuilder()

      • IpMappingBuilder

        public IpMappingBuilder​(IpMapping base)

    • Method Detail

      • getIpMap

        public java.util.List<IpMap> getIpMap()

      • getSegmentId

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

      • augmentation

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

      • setSegmentId

        public IpMappingBuilder setSegmentId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setSegmentId

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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