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

Class UpdatedFlowBuilder

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

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

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

    • Constructor Detail

      • UpdatedFlowBuilder

        public UpdatedFlowBuilder()

      • UpdatedFlowBuilder

        public UpdatedFlowBuilder​(Flow arg)

      • UpdatedFlowBuilder

        public UpdatedFlowBuilder​(UpdatedFlow 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.flow.types.rev131026.GenericFlowAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getBufferId

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

      • getContainerName

        public String getContainerName()

      • getCookieMask

        public FlowCookie getCookieMask()

      • getFlowName

        public String getFlowName()

      • getHardTimeout

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

      • getIdleTimeout

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

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

      • getTableId

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

      • isBarrier

        public Boolean isBarrier()

      • isInstallHw

        public Boolean isInstallHw()

      • isStrict

        public Boolean isStrict()

      • augmentation

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

      • setBufferId

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

      • setBufferId

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

      • setHardTimeout

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

      • setIdleTimeout

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

      • setOutGroup

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

      • setOutGroup

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

      • setOutPort

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

      • setPriority

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

      • setTableId

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

      • setTableId

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

      • addAugmentation

        public UpdatedFlowBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedFlow> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • addAugmentation

        @Deprecated(forRemoval=true)
public UpdatedFlowBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedFlow>> augmentationType,
                                          org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedFlow> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

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