Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026

Class FlowMessageBuilder

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

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

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

    • Constructor Detail

      • FlowMessageBuilder

        public FlowMessageBuilder()

      • FlowMessageBuilder

        public FlowMessageBuilder​(Flow arg)

      • FlowMessageBuilder

        public FlowMessageBuilder​(OfHeader arg)

      • FlowMessageBuilder

        public FlowMessageBuilder​(FlowMessage 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
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
        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()

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

      • getVersion

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

      • getXid

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

      • augmentation

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

      • setBufferId

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

      • setBufferId

        @Deprecated(forRemoval=true)
public FlowMessageBuilder 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 FlowMessageBuilder setHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setIdleTimeout

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

      • setOutGroup

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

      • setOutGroup

        @Deprecated(forRemoval=true)
public FlowMessageBuilder 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 FlowMessageBuilder setOutPort​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setPriority

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

      • setTableId

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

      • setTableId

        @Deprecated(forRemoval=true)
public FlowMessageBuilder 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

      • setVersion

        public FlowMessageBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setVersion

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

      • setXid

        public FlowMessageBuilder setXid​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setXid

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

      • addAugmentation

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