Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819

Class RemoveFlowInputBuilder

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

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

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

    • Constructor Detail

      • RemoveFlowInputBuilder

        public RemoveFlowInputBuilder()

      • RemoveFlowInputBuilder

        public RemoveFlowInputBuilder​(NodeFlow arg)

      • RemoveFlowInputBuilder

        public RemoveFlowInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)

      • RemoveFlowInputBuilder

        public RemoveFlowInputBuilder​(Flow arg)

      • RemoveFlowInputBuilder

        public RemoveFlowInputBuilder​(RemoveFlowInput 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.flow.transaction.rev150304.TransactionMetadata
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeFlow
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBarrier

        public Boolean getBarrier()

      • isBarrier

        @Deprecated(forRemoval=true)
public final Boolean isBarrier()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getBufferId

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

      • getContainerName

        public String getContainerName()

      • getCookieMask

        public FlowCookie getCookieMask()

      • getFlowName

        public String getFlowName()

      • getFlowRef

        public FlowRef getFlowRef()

      • getHardTimeout

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

      • getIdleTimeout

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

      • getInstallHw

        public Boolean getInstallHw()

      • isInstallHw

        @Deprecated(forRemoval=true)
public final Boolean isInstallHw()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getMatch

        public Match getMatch()

      • getNode

        public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()

      • getOutGroup

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

      • getOutPort

        public org.opendaylight.yangtools.yang.common.Uint64 getOutPort()

      • getPriority

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

      • getStrict

        public Boolean getStrict()

      • isStrict

        @Deprecated(forRemoval=true)
public final Boolean isStrict()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getTableId

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

      • getTransactionUri

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()

      • augmentation

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

      • setBufferId

        public RemoveFlowInputBuilder setBufferId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setHardTimeout

        public RemoveFlowInputBuilder setHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setIdleTimeout

        public RemoveFlowInputBuilder setIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setNode

        public RemoveFlowInputBuilder setNode​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)

      • setOutGroup

        public RemoveFlowInputBuilder setOutGroup​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setOutPort

        public RemoveFlowInputBuilder setOutPort​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setPriority

        public RemoveFlowInputBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setTableId

        public RemoveFlowInputBuilder setTableId​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setTransactionUri

        public RemoveFlowInputBuilder setTransactionUri​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)

      • addAugmentation

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