Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.learn.grouping

Class NxLearnBuilder

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

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

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

    • Constructor Detail

      • NxLearnBuilder

        public NxLearnBuilder()

      • NxLearnBuilder

        public NxLearnBuilder​(NxLearn base)

    • Method Detail

      • getCookie

        public org.opendaylight.yangtools.yang.common.Uint64 getCookie()

      • getFinHardTimeout

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

      • getFinIdleTimeout

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

      • getFlags

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

      • getHardTimeout

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

      • getIdleTimeout

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

      • getPriority

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

      • getTableId

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

      • augmentation

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

      • setCookie

        public NxLearnBuilder setCookie​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setFinHardTimeout

        public NxLearnBuilder setFinHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setFinIdleTimeout

        public NxLearnBuilder setFinIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setFlags

        public NxLearnBuilder setFlags​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setFlags

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

      • setHardTimeout

        public NxLearnBuilder setHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setIdleTimeout

        public NxLearnBuilder setIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setPriority

        public NxLearnBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setPriority

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

      • setTableId

        public NxLearnBuilder setTableId​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setTableId

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

      • addAugmentation

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

      • build

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