Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.flow.table.statistics

Class FlowTableStatisticsBuilder

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

       
     FlowTableStatistics createFlowTableStatistics(int fooXyzzy, int barBaz) {
         return new FlowTableStatisticsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • FlowTableStatisticsBuilder

        public FlowTableStatisticsBuilder()
        Construct an empty builder.

      • FlowTableStatisticsBuilder

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

      • FlowTableStatisticsBuilder

        public FlowTableStatisticsBuilder​(FlowTableStatistics base)
        Construct a builder initialized with state from specified FlowTableStatistics.
        Parameters:
        base - FlowTableStatistics 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

      • getActiveFlows

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getActiveFlows()
        Return current value associated with the property corresponding to GenericTableStatistics.getActiveFlows().
        Returns:
        current value

      • getPacketsLookedUp

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketsLookedUp()
        Return current value associated with the property corresponding to GenericTableStatistics.getPacketsLookedUp().
        Returns:
        current value

      • getPacketsMatched

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketsMatched()
        Return current value associated with the property corresponding to GenericTableStatistics.getPacketsMatched().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableStatistics>> 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

      • setActiveFlows

        public FlowTableStatisticsBuilder setActiveFlows​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to GenericTableStatistics.getActiveFlows() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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