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

Class NxMultipathBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<NxMultipath>, org.opendaylight.yangtools.concepts.CheckedBuilder<NxMultipath,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class NxMultipathBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxMultipath>
    Class that builds NxMultipathBuilder 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: 

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

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

    • Constructor Detail

      • NxMultipathBuilder

        public NxMultipathBuilder()

      • NxMultipathBuilder

        public NxMultipathBuilder​(NxMultipath base)

    • Method Detail

      • getAlgorithm

        public org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxMpAlgorithm getAlgorithm()

      • getArg

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

      • getBasis

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

      • getDst

        public Dst getDst()

      • getFields

        public org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxHashFields getFields()

      • getMaxLink

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

      • augmentation

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

      • setAlgorithm

        public NxMultipathBuilder setAlgorithm​(org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxMpAlgorithm value)

      • setArg

        public NxMultipathBuilder setArg​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setArg

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

      • setBasis

        public NxMultipathBuilder setBasis​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setBasis

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

      • setFields

        public NxMultipathBuilder setFields​(org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxHashFields value)

      • setMaxLink

        public NxMultipathBuilder setMaxLink​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setMaxLink

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

      • addAugmentation

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

      • addAugmentation

        @Deprecated(forRemoval=true)
public NxMultipathBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>> augmentationType,
                                          org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

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