Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow

Class FlowStatsBuilder

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

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

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

    • 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.oxm.rev150225.MatchGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ActionsGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.InstructionsGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • 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 org.opendaylight.yangtools.yang.common.Uint8 getTableId()

      • augmentation

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

      • setByteCount

        public FlowStatsBuilder setByteCount​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setCookie

        public FlowStatsBuilder setCookie​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setDurationNsec

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

      • setDurationNsec

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

      • setDurationSec

        public FlowStatsBuilder setDurationSec​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDurationSec

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

      • setHardTimeout

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

      • setIdleTimeout

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

      • setPacketCount

        public FlowStatsBuilder setPacketCount​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setPriority

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

      • setTableId

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

      • setTableId

        @Deprecated(forRemoval=true)
public FlowStatsBuilder 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 FlowStatsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats> 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 FlowStatsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> 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