Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class FlowRemovedMessageBuilder

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

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

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

    • Constructor Detail

      • FlowRemovedMessageBuilder

        public FlowRemovedMessageBuilder()

      • FlowRemovedMessageBuilder

        public FlowRemovedMessageBuilder​(FlowRemoved arg)

      • FlowRemovedMessageBuilder

        public FlowRemovedMessageBuilder​(OfHeader arg)

      • FlowRemovedMessageBuilder

        public FlowRemovedMessageBuilder​(MatchGrouping arg)

      • FlowRemovedMessageBuilder

        public FlowRemovedMessageBuilder​(MatchV10Grouping arg)

      • FlowRemovedMessageBuilder

        public FlowRemovedMessageBuilder​(FlowRemovedMessage 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.openflow.oxm.rev150225.MatchV10Grouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping
        • 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

      • getByteCount

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

      • getCookie

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

      • getDurationNsec

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

      • getDurationSec

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

      • getHardTimeout

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

      • getIdleTimeout

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

      • getMatch

        public Match getMatch()

      • getMatchV10

        public MatchV10 getMatchV10()

      • getPacketCount

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

      • getPriority

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

      • getTableId

        public TableId 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<FlowRemovedMessage>> E$$ augmentation​(Class<E$$> augmentationType)

      • setByteCount

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

      • setCookie

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

      • setDurationNsec

        public FlowRemovedMessageBuilder setDurationNsec​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDurationNsec

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

      • setDurationSec

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

      • setHardTimeout

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

      • setIdleTimeout

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

      • setPacketCount

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

      • setPriority

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

      • setVersion

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

      • setXid

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