Class TableStatsBuilder

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

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

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

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

      • TableStatsBuilder

        public TableStatsBuilder()
      • TableStatsBuilder

        public TableStatsBuilder​(TableStats base)
    • Method Detail

      • getActiveCount

        public org.opendaylight.yangtools.yang.common.Uint32 getActiveCount()
      • getLookupCount

        public org.opendaylight.yangtools.yang.common.Uint64 getLookupCount()
      • getMatchedCount

        public org.opendaylight.yangtools.yang.common.Uint64 getMatchedCount()
      • getMaxEntries

        public org.opendaylight.yangtools.yang.common.Uint32 getMaxEntries()
      • getName

        public String getName()
      • getNwDstMask

        public org.opendaylight.yangtools.yang.common.Uint8 getNwDstMask()
      • getNwSrcMask

        public org.opendaylight.yangtools.yang.common.Uint8 getNwSrcMask()
      • getTableId

        public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
      • augmentation

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

        public TableStatsBuilder setActiveCount​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setLookupCount

        public TableStatsBuilder setLookupCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setMatchedCount

        public TableStatsBuilder setMatchedCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setMaxEntries

        public TableStatsBuilder setMaxEntries​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setMaxEntries

        @Deprecated(forRemoval=true)
        public TableStatsBuilder setMaxEntries​(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
      • setNwDstMask

        public TableStatsBuilder setNwDstMask​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setNwDstMask

        @Deprecated(forRemoval=true)
        public TableStatsBuilder setNwDstMask​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNwDstMask(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setNwSrcMask

        public TableStatsBuilder setNwSrcMask​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setNwSrcMask

        @Deprecated(forRemoval=true)
        public TableStatsBuilder setNwSrcMask​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNwSrcMask(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setTableId

        public TableStatsBuilder setTableId​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setTableId

        @Deprecated(forRemoval=true)
        public TableStatsBuilder setTableId​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setTableId(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        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