Class TableStatsBuilder


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

       
         TableStats createTableStats(int fooXyzzy, int barBaz) {
             return new TableStatsBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • TableStatsBuilder

        public TableStatsBuilder()
        Construct an empty builder.
      • TableStatsBuilder

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

      • getActiveCount

        public org.opendaylight.yangtools.yang.common.Uint32 getActiveCount()
        Return current value associated with the property corresponding to TableStats.getActiveCount().
        Returns:
        current value
      • getLookupCount

        public org.opendaylight.yangtools.yang.common.Uint64 getLookupCount()
        Return current value associated with the property corresponding to TableStats.getLookupCount().
        Returns:
        current value
      • getMatchedCount

        public org.opendaylight.yangtools.yang.common.Uint64 getMatchedCount()
        Return current value associated with the property corresponding to TableStats.getMatchedCount().
        Returns:
        current value
      • getMaxEntries

        public org.opendaylight.yangtools.yang.common.Uint32 getMaxEntries()
        Return current value associated with the property corresponding to TableStats.getMaxEntries().
        Returns:
        current value
      • getName

        public String getName()
        Return current value associated with the property corresponding to TableStats.getName().
        Returns:
        current value
      • getNwDstMask

        public org.opendaylight.yangtools.yang.common.Uint8 getNwDstMask()
        Return current value associated with the property corresponding to TableStats.getNwDstMask().
        Returns:
        current value
      • getNwSrcMask

        public org.opendaylight.yangtools.yang.common.Uint8 getNwSrcMask()
        Return current value associated with the property corresponding to TableStats.getNwSrcMask().
        Returns:
        current value
      • getTableId

        public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
        Return current value associated with the property corresponding to TableStats.getTableId().
        Returns:
        current value
      • augmentation

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

        public TableStatsBuilder setActiveCount​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to TableStats.getActiveCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setLookupCount

        public TableStatsBuilder setLookupCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to TableStats.getLookupCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setMatchedCount

        public TableStatsBuilder setMatchedCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to TableStats.getMatchedCount() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setMaxEntries

        public TableStatsBuilder setMaxEntries​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to TableStats.getMaxEntries() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setNwDstMask

        public TableStatsBuilder setNwDstMask​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to TableStats.getNwDstMask() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setNwSrcMask

        public TableStatsBuilder setNwSrcMask​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to TableStats.getNwSrcMask() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setTableId

        public TableStatsBuilder setTableId​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to TableStats.getTableId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • addAugmentation

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