Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.multipart.request.multipart.request.body.multipart.request.flow.stats

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​(Flow arg)
        Construct a new builder initialized from specified Flow.
        Parameters:
        arg - Flow from which the builder should be initialized

      • FlowStatsBuilder

        public FlowStatsBuilder​(GenericFlowAttributes arg)
        Construct a new builder initialized from specified GenericFlowAttributes.
        Parameters:
        arg - GenericFlowAttributes 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

      • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBarrier

        public Boolean getBarrier()
        Return current value associated with the property corresponding to Flow.getBarrier().
        Returns:
        current value

      • getBufferId

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

      • getContainerName

        public String getContainerName()
        Return current value associated with the property corresponding to Flow.getContainerName().
        Returns:
        current value

      • getCookieMask

        public FlowCookie getCookieMask()
        Return current value associated with the property corresponding to Flow.getCookieMask().
        Returns:
        current value

      • getFlags

        public FlowModFlags getFlags()
        Return current value associated with the property corresponding to Flow.getFlags().
        Returns:
        current value

      • getFlowName

        public String getFlowName()
        Return current value associated with the property corresponding to Flow.getFlowName().
        Returns:
        current value

      • getHardTimeout

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

      • getIdleTimeout

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

      • getInstallHw

        public Boolean getInstallHw()
        Return current value associated with the property corresponding to Flow.getInstallHw().
        Returns:
        current value

      • getInstructions

        public Instructions getInstructions()
        Return current value associated with the property corresponding to Flow.getInstructions().
        Returns:
        current value

      • getMatch

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

      • getOutGroup

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

      • getOutPort

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

      • getPriority

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

      • getStrict

        public Boolean getStrict()
        Return current value associated with the property corresponding to Flow.getStrict().
        Returns:
        current value

      • getTableId

        public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
        Return current value associated with the property corresponding to GenericFlowAttributes.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

      • setBarrier

        public FlowStatsBuilder setBarrier​(Boolean value)
        Set the property corresponding to Flow.getBarrier() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setBufferId

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

      • setFlowName

        public FlowStatsBuilder setFlowName​(String value)
        Set the property corresponding to Flow.getFlowName() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMatch

        public FlowStatsBuilder setMatch​(Match value)
        Set the property corresponding to Flow.getMatch() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setOutGroup

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

      • setOutPort

        public FlowStatsBuilder setOutPort​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to Flow.getOutPort() 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 GenericFlowAttributes.getPriority() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setStrict

        public FlowStatsBuilder setStrict​(Boolean value)
        Set the property corresponding to Flow.getStrict() 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 GenericFlowAttributes.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