Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers.peer

Class StatsBuilder

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

       
     Stats createStats(int fooXyzzy, int barBaz) {
         return new StatsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • StatsBuilder

        public StatsBuilder()
        Construct an empty builder.

      • StatsBuilder

        public StatsBuilder​(Timestamp arg)
        Construct a new builder initialized from specified Timestamp.
        Parameters:
        arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Timestamp from which the builder should be initialized

      • StatsBuilder

        public StatsBuilder​(Stats base)
        Construct a builder initialized with state from specified Stats.
        Parameters:
        base - Stats from which the builder should be initialized

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAdjRibsInRoutes

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 getAdjRibsInRoutes()
        Return current value associated with the property corresponding to Stats.getAdjRibsInRoutes().
        Returns:
        current value

      • getDuplicatePrefixAdvertisements

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

      • getDuplicateUpdates

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

      • getDuplicateWithdraws

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

      • getInvalidatedAsConfedLoop

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

      • getInvalidatedAsPathLoop

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

      • getInvalidatedClusterListLoop

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

      • getInvalidatedOriginatorId

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

      • getLocRibRoutes

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 getLocRibRoutes()
        Return current value associated with the property corresponding to Stats.getLocRibRoutes().
        Returns:
        current value

      • getPrefixesTreatedAsWithdraw

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

      • getRejectedPrefixes

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

      • getTimestampMicro

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampMicro()
        Return current value associated with the property corresponding to Timestamp.getTimestampMicro().
        Returns:
        current value

      • getTimestampSec

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampSec()
        Return current value associated with the property corresponding to Timestamp.getTimestampSec().
        Returns:
        current value

      • getUpdatesTreatedAsWithdraw

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

      • augmentation

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

      • setAdjRibsInRoutes

        public StatsBuilder setAdjRibsInRoutes​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 value)
        Set the property corresponding to Stats.getAdjRibsInRoutes() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setDuplicatePrefixAdvertisements

        public StatsBuilder setDuplicatePrefixAdvertisements​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getDuplicatePrefixAdvertisements() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setDuplicateUpdates

        public StatsBuilder setDuplicateUpdates​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getDuplicateUpdates() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setDuplicateWithdraws

        public StatsBuilder setDuplicateWithdraws​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getDuplicateWithdraws() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setInvalidatedAsConfedLoop

        public StatsBuilder setInvalidatedAsConfedLoop​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getInvalidatedAsConfedLoop() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setInvalidatedAsPathLoop

        public StatsBuilder setInvalidatedAsPathLoop​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getInvalidatedAsPathLoop() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setInvalidatedClusterListLoop

        public StatsBuilder setInvalidatedClusterListLoop​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getInvalidatedClusterListLoop() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setInvalidatedOriginatorId

        public StatsBuilder setInvalidatedOriginatorId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getInvalidatedOriginatorId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setLocRibRoutes

        public StatsBuilder setLocRibRoutes​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 value)
        Set the property corresponding to Stats.getLocRibRoutes() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPrefixesTreatedAsWithdraw

        public StatsBuilder setPrefixesTreatedAsWithdraw​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getPrefixesTreatedAsWithdraw() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setRejectedPrefixes

        public StatsBuilder setRejectedPrefixes​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getRejectedPrefixes() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTimestampMicro

        public StatsBuilder setTimestampMicro​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
        Set the property corresponding to Timestamp.getTimestampMicro() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTimestampSec

        public StatsBuilder setTimestampSec​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
        Set the property corresponding to Timestamp.getTimestampSec() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setUpdatesTreatedAsWithdraw

        public StatsBuilder setUpdatesTreatedAsWithdraw​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
        Set the property corresponding to Stats.getUpdatesTreatedAsWithdraw() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public StatsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Stats> 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 StatsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Stats>> 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 @NonNull Stats build()
        A new Stats instance.
        Returns:
        A new Stats instance.