Package org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features

Class TableFeaturesBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<TableFeatures>, org.opendaylight.yangtools.concepts.CheckedBuilder<TableFeatures,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class TableFeaturesBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<TableFeatures>
    Class that builds TableFeaturesBuilder 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: 

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

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

    • Constructor Detail

      • TableFeaturesBuilder

        public TableFeaturesBuilder()

      • TableFeaturesBuilder

        public TableFeaturesBuilder​(TableFeatures base)

    • Method Detail

      • getMaxEntries

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

      • getMetadataMatch

        public org.opendaylight.yangtools.yang.common.Uint64 getMetadataMatch()

      • getMetadataWrite

        public org.opendaylight.yangtools.yang.common.Uint64 getMetadataWrite()

      • getName

        public String getName()

      • getTableId

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

      • augmentation

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

      • setMaxEntries

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

      • setMaxEntries

        @Deprecated(forRemoval=true)
public TableFeaturesBuilder setMaxEntries​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setMaxEntries(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setMetadataMatch

        public TableFeaturesBuilder setMetadataMatch​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setMetadataMatch

        @Deprecated(forRemoval=true)
public TableFeaturesBuilder setMetadataMatch​(BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setMetadataMatch(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setMetadataWrite

        public TableFeaturesBuilder setMetadataWrite​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setMetadataWrite

        @Deprecated(forRemoval=true)
public TableFeaturesBuilder setMetadataWrite​(BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setMetadataWrite(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setTableId

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

      • setTableId

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

      • addAugmentation

        public TableFeaturesBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> augmentationType,
                                            org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures> augmentationValue)