Class PortStatsBuilder

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

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

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

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

      • PortStatsBuilder

        public PortStatsBuilder()
      • PortStatsBuilder

        public PortStatsBuilder​(PortStats base)
    • Method Detail

      • getCollisions

        public org.opendaylight.yangtools.yang.common.Uint64 getCollisions()
      • 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()
      • getRxBytes

        public org.opendaylight.yangtools.yang.common.Uint64 getRxBytes()
      • getRxCrcErr

        public org.opendaylight.yangtools.yang.common.Uint64 getRxCrcErr()
      • getRxDropped

        public org.opendaylight.yangtools.yang.common.Uint64 getRxDropped()
      • getRxErrors

        public org.opendaylight.yangtools.yang.common.Uint64 getRxErrors()
      • getRxFrameErr

        public org.opendaylight.yangtools.yang.common.Uint64 getRxFrameErr()
      • getRxOverErr

        public org.opendaylight.yangtools.yang.common.Uint64 getRxOverErr()
      • getRxPackets

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

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

        public org.opendaylight.yangtools.yang.common.Uint64 getTxDropped()
      • 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<PortStats>> E$$ augmentation​(Class<E$$> augmentationType)
      • setCollisions

        public PortStatsBuilder setCollisions​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setDurationNsec

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

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

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

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

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

        @Deprecated(forRemoval=true)
        public PortStatsBuilder 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
      • setRxBytes

        public PortStatsBuilder setRxBytes​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setRxCrcErr

        public PortStatsBuilder setRxCrcErr​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setRxDropped

        public PortStatsBuilder setRxDropped​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setRxErrors

        public PortStatsBuilder setRxErrors​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setRxFrameErr

        public PortStatsBuilder setRxFrameErr​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setRxOverErr

        public PortStatsBuilder setRxOverErr​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setRxPackets

        public PortStatsBuilder setRxPackets​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setTxBytes

        public PortStatsBuilder setTxBytes​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setTxDropped

        public PortStatsBuilder setTxDropped​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setTxErrors

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

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

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