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

Class NxmNxNshc2Builder

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

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

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

    • Constructor Detail

      • NxmNxNshc2Builder

        public NxmNxNshc2Builder()

      • NxmNxNshc2Builder

        public NxmNxNshc2Builder​(NxmNxNshc2 base)

    • Method Detail

      • getMask

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

      • getValue

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

      • augmentation

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

      • setMask

        public NxmNxNshc2Builder setMask​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMask

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

      • setValue

        public NxmNxNshc2Builder setValue​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setValue

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

      • addAugmentation

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