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

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

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

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

    • Constructor Detail

      • MeterStatsBuilder

        public MeterStatsBuilder()
        Construct an empty builder.

      • MeterStatsBuilder

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

    • Method Detail

      • getByteInCount

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

      • getDurationNsec

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

      • getDurationSec

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

      • getFlowCount

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

      • getMeterId

        public MeterId getMeterId()
        Return current value associated with the property corresponding to MeterStats.getMeterId().
        Returns:
        current value

      • getPacketInCount

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

      • augmentation

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

      • setByteInCount

        public MeterStatsBuilder setByteInCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to MeterStats.getByteInCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setDurationNsec

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

      • setDurationSec

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

      • setFlowCount

        public MeterStatsBuilder setFlowCount​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to MeterStats.getFlowCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPacketInCount

        public MeterStatsBuilder setPacketInCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to MeterStats.getPacketInCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • 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