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

Class DstBuilder

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

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

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

    • Constructor Detail

      • DstBuilder

        public DstBuilder()

      • DstBuilder

        public DstBuilder​(Dst base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.RangeGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.DstChoiceGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getDstChoice

        public DstChoice getDstChoice()

      • getEnd

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

      • getStart

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

      • augmentation

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

      • setEnd

        public DstBuilder setEnd​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setEnd

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

      • setStart

        public DstBuilder setStart​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setStart

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

      • addAugmentation

        public DstBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Dst> 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 DstBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> 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 Dst build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Dst>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Dst,​IllegalArgumentException>