Class QueueStatsBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<QueueStats>, org.opendaylight.yangtools.concepts.CheckedBuilder<QueueStats,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    @Generated("mdsal-binding-generator")
    public class QueueStatsBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<QueueStats>
    Class that builds QueueStatsBuilder 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:

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

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

      • QueueStatsBuilder

        public QueueStatsBuilder()
      • QueueStatsBuilder

        public QueueStatsBuilder​(QueueStats base)
    • Method Detail

      • getDurationNsec

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

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

        public org.opendaylight.yangtools.yang.common.Uint32 getPortNo()
      • getQueueId

        public org.opendaylight.yangtools.yang.common.Uint32 getQueueId()
      • getTxBytes

        public org.opendaylight.yangtools.yang.common.Uint64 getTxBytes()
      • getTxErrors

        public org.opendaylight.yangtools.yang.common.Uint64 getTxErrors()
      • getTxPackets

        public org.opendaylight.yangtools.yang.common.Uint64 getTxPackets()
      • augmentation

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

        public QueueStatsBuilder setDurationNsec​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setDurationSec

        public QueueStatsBuilder setDurationSec​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setPortNo

        public QueueStatsBuilder setPortNo​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setPortNo

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

        public QueueStatsBuilder setQueueId​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setQueueId

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

        public QueueStatsBuilder setTxBytes​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setTxErrors

        public QueueStatsBuilder setTxErrors​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setTxPackets

        public QueueStatsBuilder setTxPackets​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • addAugmentation

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