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

Class NxLearnBuilder

  • @Generated("mdsal-binding-generator")
public class NxLearnBuilder
extends Object
    Class that builds NxLearn 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: 

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

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

    • Constructor Detail

      • NxLearnBuilder

        public NxLearnBuilder()
        Construct an empty builder.

      • NxLearnBuilder

        public NxLearnBuilder​(NxLearn base)
        Construct a builder initialized with state from specified NxLearn.
        Parameters:
        base - NxLearn from which the builder should be initialized

    • Method Detail

      • getCookie

        public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
        Return current value associated with the property corresponding to NxLearn.getCookie().
        Returns:
        current value

      • getFinHardTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getFinHardTimeout()
        Return current value associated with the property corresponding to NxLearn.getFinHardTimeout().
        Returns:
        current value

      • getFinIdleTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getFinIdleTimeout()
        Return current value associated with the property corresponding to NxLearn.getFinIdleTimeout().
        Returns:
        current value

      • getFlags

        public org.opendaylight.yangtools.yang.common.Uint16 getFlags()
        Return current value associated with the property corresponding to NxLearn.getFlags().
        Returns:
        current value

      • getHardTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
        Return current value associated with the property corresponding to NxLearn.getHardTimeout().
        Returns:
        current value

      • getIdleTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
        Return current value associated with the property corresponding to NxLearn.getIdleTimeout().
        Returns:
        current value

      • getPriority

        public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
        Return current value associated with the property corresponding to NxLearn.getPriority().
        Returns:
        current value

      • getTableId

        public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
        Return current value associated with the property corresponding to NxLearn.getTableId().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxLearn>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setCookie

        public NxLearnBuilder setCookie​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to NxLearn.getCookie() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setFinHardTimeout

        public NxLearnBuilder setFinHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to NxLearn.getFinHardTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setFinIdleTimeout

        public NxLearnBuilder setFinIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to NxLearn.getFinIdleTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setFlags

        public NxLearnBuilder setFlags​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to NxLearn.getFlags() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setHardTimeout

        public NxLearnBuilder setHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to NxLearn.getHardTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setIdleTimeout

        public NxLearnBuilder setIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to NxLearn.getIdleTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPriority

        public NxLearnBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to NxLearn.getPriority() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTableId

        public NxLearnBuilder setTableId​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to NxLearn.getTableId() to the specified value.
        Parameters:
        value - desired value
        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