Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec.flow.mod.copy.field.into.field._case

Class FlowModCopyFieldIntoFieldBuilder

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

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

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

    • Constructor Detail

      • FlowModCopyFieldIntoFieldBuilder

        public FlowModCopyFieldIntoFieldBuilder()

    • Method Detail

      • getDstField

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

      • getDstOfs

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

      • getFlowModNumBits

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

      • getSrcField

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

      • getSrcOfs

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

      • augmentation

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

      • setDstField

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

      • setDstOfs

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

      • setFlowModNumBits

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

      • setSrcField

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

      • setSrcOfs

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

      • removeAugmentation

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