Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.ethernet.rev210609.ethernet._interface.state

Class CountersBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Counters>, org.opendaylight.yangtools.concepts.CheckedBuilder<Counters,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class CountersBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Counters>
    Class that builds Counters 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: 

       
     Counters createCounters(int fooXyzzy, int barBaz) {
         return new CountersBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • EthernetInterfaceStateCounters
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getIn8021qFrames

        public Counter64 getIn8021qFrames()

      • getInBlockErrors

        public Counter64 getInBlockErrors()

      • getInCarrierErrors

        public Counter64 getInCarrierErrors()

      • getInCrcErrors

        public Counter64 getInCrcErrors()

      • getInFragmentFrames

        public Counter64 getInFragmentFrames()

      • getInInterruptedTx

        public Counter64 getInInterruptedTx()

      • getInJabberFrames

        public Counter64 getInJabberFrames()

      • getInLateCollision

        public Counter64 getInLateCollision()

      • getInMacControlFrames

        public Counter64 getInMacControlFrames()

      • getInMacErrorsRx

        public Counter64 getInMacErrorsRx()

      • getInMacPauseFrames

        public Counter64 getInMacPauseFrames()

      • getInMaxsizeExceeded

        public Counter64 getInMaxsizeExceeded()

      • getInOversizeFrames

        public Counter64 getInOversizeFrames()

      • getInSingleCollision

        public Counter64 getInSingleCollision()

      • getInSymbolError

        public Counter64 getInSymbolError()

      • getInUndersizeFrames

        public Counter64 getInUndersizeFrames()

      • getOut8021qFrames

        public Counter64 getOut8021qFrames()

      • getOutMacControlFrames

        public Counter64 getOutMacControlFrames()

      • getOutMacErrorsTx

        public Counter64 getOutMacErrorsTx()

      • getOutMacPauseFrames

        public Counter64 getOutMacPauseFrames()

      • augmentation

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

      • addAugmentation

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

      • build

        public Counters build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Counters>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Counters,​IllegalArgumentException>