Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nsh.flags.grouping

Class NxmNxNshFlagsBuilder

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

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

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

    • Constructor Detail

      • NxmNxNshFlagsBuilder

        public NxmNxNshFlagsBuilder()

      • NxmNxNshFlagsBuilder

        public NxmNxNshFlagsBuilder​(NxmNxNshFlags base)

    • Method Detail

      • getMask

        public org.opendaylight.yangtools.yang.common.Uint8 getMask()

      • getNshFlags

        public org.opendaylight.yangtools.yang.common.Uint8 getNshFlags()

      • augmentation

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

      • setMask

        public NxmNxNshFlagsBuilder setMask​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setMask

        @Deprecated(forRemoval=true)
public NxmNxNshFlagsBuilder setMask​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setMask(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNshFlags

        public NxmNxNshFlagsBuilder setNshFlags​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • addAugmentation

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

      • removeAugmentation

        public NxmNxNshFlagsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshFlags>> 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