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

Class NxConntrackBuilder

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

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

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

    • Constructor Detail

      • NxConntrackBuilder

        public NxConntrackBuilder()

      • NxConntrackBuilder

        public NxConntrackBuilder​(NxConntrack base)

    • Method Detail

      • getConntrackZone

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

      • getFlags

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

      • getRecircTable

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

      • getZoneSrc

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

      • augmentation

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

      • setConntrackZone

        public NxConntrackBuilder setConntrackZone​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setFlags

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

      • setRecircTable

        public NxConntrackBuilder setRecircTable​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setZoneSrc

        public NxConntrackBuilder setZoneSrc​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setZoneSrc

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

      • addAugmentation

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