Class QueueStatsBuilder


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

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

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

      • QueueStatsBuilder

        public QueueStatsBuilder()
        Construct an empty builder.
      • QueueStatsBuilder

        public QueueStatsBuilder​(QueueStats base)
        Construct a builder initialized with state from specified QueueStats.
        Parameters:
        base - QueueStats from which the builder should be initialized
    • Method Detail

      • getDurationNsec

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

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

        public org.opendaylight.yangtools.yang.common.Uint32 getPortNo()
        Return current value associated with the property corresponding to QueueStats.getPortNo().
        Returns:
        current value
      • getQueueId

        public org.opendaylight.yangtools.yang.common.Uint32 getQueueId()
        Return current value associated with the property corresponding to QueueStats.getQueueId().
        Returns:
        current value
      • getTxBytes

        public org.opendaylight.yangtools.yang.common.Uint64 getTxBytes()
        Return current value associated with the property corresponding to QueueStats.getTxBytes().
        Returns:
        current value
      • getTxErrors

        public org.opendaylight.yangtools.yang.common.Uint64 getTxErrors()
        Return current value associated with the property corresponding to QueueStats.getTxErrors().
        Returns:
        current value
      • getTxPackets

        public org.opendaylight.yangtools.yang.common.Uint64 getTxPackets()
        Return current value associated with the property corresponding to QueueStats.getTxPackets().
        Returns:
        current value
      • augmentation

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

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

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

        public QueueStatsBuilder setPortNo​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to QueueStats.getPortNo() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setQueueId

        public QueueStatsBuilder setQueueId​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to QueueStats.getQueueId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setTxBytes

        public QueueStatsBuilder setTxBytes​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to QueueStats.getTxBytes() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setTxErrors

        public QueueStatsBuilder setTxErrors​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to QueueStats.getTxErrors() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setTxPackets

        public QueueStatsBuilder setTxPackets​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to QueueStats.getTxPackets() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • 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