Package org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.add.flow._case

Class FlatBatchAddFlowBuilder

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

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

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

    • Constructor Detail

      • FlatBatchAddFlowBuilder

        public FlatBatchAddFlowBuilder()

      • FlatBatchAddFlowBuilder

        public FlatBatchAddFlowBuilder​(Flow arg)

      • FlatBatchAddFlowBuilder

        public FlatBatchAddFlowBuilder​(FlatBatchAddFlow 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.types.rev131026.Flow
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowInputGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.service.batch.common.rev160322.BatchOrderGrouping
        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.

      • getBatchOrder

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

      • getBufferId

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

      • getContainerName

        public String getContainerName()

      • getCookieMask

        public FlowCookie getCookieMask()

      • getFlowId

        public FlowId getFlowId()

      • getFlowName

        public String getFlowName()

      • 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()

      • 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()

      • augmentation

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

      • setBatchOrder

        public FlatBatchAddFlowBuilder setBatchOrder​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setBufferId

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

      • setHardTimeout

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

      • setIdleTimeout

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

      • setOutGroup

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

      • setPriority

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

      • addAugmentation

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