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

Class BucketStatsBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<BucketStats>, org.opendaylight.yangtools.concepts.CheckedBuilder<BucketStats,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class BucketStatsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<BucketStats>
    Class that builds BucketStatsBuilder 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: 

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

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

    • Constructor Detail

      • BucketStatsBuilder

        public BucketStatsBuilder()

      • BucketStatsBuilder

        public BucketStatsBuilder​(BucketStats base)

    • Method Detail

      • getByteCount

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

      • getPacketCount

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

      • augmentation

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

      • setByteCount

        public BucketStatsBuilder setByteCount​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setByteCount

        @Deprecated(forRemoval=true)
public BucketStatsBuilder setByteCount​(BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setByteCount(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setPacketCount

        public BucketStatsBuilder setPacketCount​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setPacketCount

        @Deprecated(forRemoval=true)
public BucketStatsBuilder setPacketCount​(BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setPacketCount(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

        public BucketStatsBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketStats>> augmentationType,
                                          org.opendaylight.yangtools.yang.binding.Augmentation<BucketStats> augmentationValue)

      • removeAugmentation

        public BucketStatsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketStats>> augmentationType)