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

  • @Generated("mdsal-binding-generator")
public class FlowStatsBuilder
extends Object
    Class that builds FlowStats 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: 

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

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

    • Constructor Detail

      • FlowStatsBuilder

        public FlowStatsBuilder()
        Construct an empty builder.

      • FlowStatsBuilder

        public FlowStatsBuilder​(MatchGrouping arg)
        Construct a new builder initialized from specified MatchGrouping.
        Parameters:
        arg - MatchGrouping from which the builder should be initialized

      • FlowStatsBuilder

        public FlowStatsBuilder​(InstructionsGrouping arg)
        Construct a new builder initialized from specified InstructionsGrouping.
        Parameters:
        arg - InstructionsGrouping from which the builder should be initialized

      • FlowStatsBuilder

        public FlowStatsBuilder​(MatchV10Grouping arg)
        Construct a new builder initialized from specified MatchV10Grouping.
        Parameters:
        arg - MatchV10Grouping from which the builder should be initialized

      • FlowStatsBuilder

        public FlowStatsBuilder​(ActionsGrouping arg)
        Construct a new builder initialized from specified ActionsGrouping.
        Parameters:
        arg - ActionsGrouping from which the builder should be initialized

      • FlowStatsBuilder

        public FlowStatsBuilder​(FlowStats base)
        Construct a builder initialized with state from specified FlowStats.
        Parameters:
        base - FlowStats from which the builder should be initialized

    • Method Detail

      • getByteCount

        public org.opendaylight.yangtools.yang.common.Uint64 getByteCount()
        Return current value associated with the property corresponding to FlowStats.getByteCount().
        Returns:
        current value

      • getCookie

        public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
        Return current value associated with the property corresponding to FlowStats.getCookie().
        Returns:
        current value

      • getDurationNsec

        public org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()
        Return current value associated with the property corresponding to FlowStats.getDurationNsec().
        Returns:
        current value

      • getDurationSec

        public org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()
        Return current value associated with the property corresponding to FlowStats.getDurationSec().
        Returns:
        current value

      • getHardTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
        Return current value associated with the property corresponding to FlowStats.getHardTimeout().
        Returns:
        current value

      • getIdleTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
        Return current value associated with the property corresponding to FlowStats.getIdleTimeout().
        Returns:
        current value

      • getMatch

        public Match getMatch()
        Return current value associated with the property corresponding to MatchGrouping.getMatch().
        Returns:
        current value

      • getPacketCount

        public org.opendaylight.yangtools.yang.common.Uint64 getPacketCount()
        Return current value associated with the property corresponding to FlowStats.getPacketCount().
        Returns:
        current value

      • getPriority

        public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
        Return current value associated with the property corresponding to FlowStats.getPriority().
        Returns:
        current value

      • getTableId

        public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
        Return current value associated with the property corresponding to FlowStats.getTableId().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setByteCount

        public FlowStatsBuilder setByteCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to FlowStats.getByteCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setCookie

        public FlowStatsBuilder setCookie​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to FlowStats.getCookie() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setDurationNsec

        public FlowStatsBuilder setDurationNsec​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to FlowStats.getDurationNsec() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setDurationSec

        public FlowStatsBuilder setDurationSec​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to FlowStats.getDurationSec() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setHardTimeout

        public FlowStatsBuilder setHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to FlowStats.getHardTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setIdleTimeout

        public FlowStatsBuilder setIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to FlowStats.getIdleTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPacketCount

        public FlowStatsBuilder setPacketCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to FlowStats.getPacketCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPriority

        public FlowStatsBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to FlowStats.getPriority() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTableId

        public FlowStatsBuilder setTableId​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to FlowStats.getTableId() to the specified value.
        Parameters:
        value - desired value
        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