Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.autoattach

Class MappingsBuilder

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

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

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

    • Constructor Detail

      • MappingsBuilder

        public MappingsBuilder()

      • MappingsBuilder

        public MappingsBuilder​(Mappings base)

    • Method Detail

      • getMappingsKey

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

      • getMappingsValue

        public org.opendaylight.yangtools.yang.common.Uint16 getMappingsValue()

      • augmentation

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

      • setMappingsKey

        public MappingsBuilder setMappingsKey​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMappingsKey

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

      • setMappingsValue

        public MappingsBuilder setMappingsValue​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setMappingsValue

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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