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

Class MeterStatsBuilder

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

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

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

    • Constructor Detail

      • MeterStatsBuilder

        public MeterStatsBuilder()

      • MeterStatsBuilder

        public MeterStatsBuilder​(MeterStats base)

    • Method Detail

      • getByteInCount

        public org.opendaylight.yangtools.yang.common.Uint64 getByteInCount()

      • getDurationNsec

        public org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()

      • getDurationSec

        public org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()

      • getFlowCount

        public org.opendaylight.yangtools.yang.common.Uint32 getFlowCount()

      • getMeterId

        public MeterId getMeterId()

      • getPacketInCount

        public org.opendaylight.yangtools.yang.common.Uint64 getPacketInCount()

      • augmentation

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

      • setByteInCount

        public MeterStatsBuilder setByteInCount​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setDurationNsec

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

      • setDurationSec

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

      • setFlowCount

        public MeterStatsBuilder setFlowCount​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setFlowCount

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

      • setPacketInCount

        public MeterStatsBuilder setPacketInCount​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • addAugmentation

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