Class CountersBuilder


  • @Generated("mdsal-binding-generator")
    public class CountersBuilder
    extends Object
    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
    • Constructor Detail

      • CountersBuilder

        public CountersBuilder()
        Construct an empty builder.
      • CountersBuilder

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

      • getInBroadcastPkts

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInBroadcastPkts()
        Return current value associated with the property corresponding to Counters.getInBroadcastPkts().
        Returns:
        current value
      • getInDiscards

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInDiscards()
        Return current value associated with the property corresponding to Counters.getInDiscards().
        Returns:
        current value
      • getInErrors

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInErrors()
        Return current value associated with the property corresponding to Counters.getInErrors().
        Returns:
        current value
      • getInMulticastPkts

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInMulticastPkts()
        Return current value associated with the property corresponding to Counters.getInMulticastPkts().
        Returns:
        current value
      • getInOctets

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInOctets()
        Return current value associated with the property corresponding to Counters.getInOctets().
        Returns:
        current value
      • getInUnicastPkts

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInUnicastPkts()
        Return current value associated with the property corresponding to Counters.getInUnicastPkts().
        Returns:
        current value
      • getInUnknownProtos

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getInUnknownProtos()
        Return current value associated with the property corresponding to Counters.getInUnknownProtos().
        Returns:
        current value
      • getLastClear

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getLastClear()
        Return current value associated with the property corresponding to Counters.getLastClear().
        Returns:
        current value
      • getOutBroadcastPkts

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutBroadcastPkts()
        Return current value associated with the property corresponding to Counters.getOutBroadcastPkts().
        Returns:
        current value
      • getOutDiscards

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutDiscards()
        Return current value associated with the property corresponding to Counters.getOutDiscards().
        Returns:
        current value
      • getOutErrors

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutErrors()
        Return current value associated with the property corresponding to Counters.getOutErrors().
        Returns:
        current value
      • getOutMulticastPkts

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutMulticastPkts()
        Return current value associated with the property corresponding to Counters.getOutMulticastPkts().
        Returns:
        current value
      • getOutOctets

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutOctets()
        Return current value associated with the property corresponding to Counters.getOutOctets().
        Returns:
        current value
      • getOutUnicastPkts

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutUnicastPkts()
        Return current value associated with the property corresponding to Counters.getOutUnicastPkts().
        Returns:
        current value
      • augmentation

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

        public CountersBuilder setInBroadcastPkts​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getInBroadcastPkts() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setInDiscards

        public CountersBuilder setInDiscards​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getInDiscards() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setInErrors

        public CountersBuilder setInErrors​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getInErrors() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setInMulticastPkts

        public CountersBuilder setInMulticastPkts​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getInMulticastPkts() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setInOctets

        public CountersBuilder setInOctets​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getInOctets() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setInUnicastPkts

        public CountersBuilder setInUnicastPkts​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getInUnicastPkts() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setInUnknownProtos

        public CountersBuilder setInUnknownProtos​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Counters.getInUnknownProtos() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setLastClear

        public CountersBuilder setLastClear​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value)
        Set the property corresponding to Counters.getLastClear() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setOutBroadcastPkts

        public CountersBuilder setOutBroadcastPkts​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getOutBroadcastPkts() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setOutDiscards

        public CountersBuilder setOutDiscards​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getOutDiscards() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setOutErrors

        public CountersBuilder setOutErrors​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getOutErrors() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setOutMulticastPkts

        public CountersBuilder setOutMulticastPkts​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getOutMulticastPkts() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setOutOctets

        public CountersBuilder setOutOctets​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getOutOctets() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setOutUnicastPkts

        public CountersBuilder setOutUnicastPkts​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
        Set the property corresponding to Counters.getOutUnicastPkts() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • 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