Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.statistics

Class FlowStatisticsBuilder

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

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

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

    • Constructor Detail

      • FlowStatisticsBuilder

        public FlowStatisticsBuilder()

      • FlowStatisticsBuilder

        public FlowStatisticsBuilder​(Duration arg)

      • FlowStatisticsBuilder

        public FlowStatisticsBuilder​(FlowStatistics 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.model.statistics.types.rev130925.GenericStatistics
        • org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.Duration
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getByteCount

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()

      • getDuration

        public Duration getDuration()

      • getPacketCount

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()

      • augmentation

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

      • setByteCount

        public FlowStatisticsBuilder setByteCount​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)

      • setPacketCount

        public FlowStatisticsBuilder setPacketCount​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)

      • addAugmentation

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