Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.output.reg.grouping

Class NxActionOutputRegBuilder

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

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

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

    • Constructor Detail

      • NxActionOutputRegBuilder

        public NxActionOutputRegBuilder()

      • NxActionOutputRegBuilder

        public NxActionOutputRegBuilder​(NxActionOutputReg base)

    • Method Detail

      • getMaxLen

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

      • getNBits

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

      • getSrc

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

      • augmentation

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

      • setMaxLen

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

      • setNBits

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

      • setSrc

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