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

Class TableFeaturesBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.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 Summary

Constructors

Constructor and Description
TableFeaturesBuilder()
TableFeaturesBuilder(TableFeatures base)

Method Summary

Modifier and Type	Method and Description
TableFeaturesBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> E$$	augmentation(Class<E$$> augmentationType)
TableFeatures	build()
TableConfig	getConfig()
Long	getMaxEntries()
BigInteger	getMetadataMatch()
BigInteger	getMetadataWrite()
String	getName()
Short	getTableId()
TableProperties	getTableProperties()
TableFeaturesKey	key()
TableFeaturesBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> augmentationType)
TableFeaturesBuilder	setConfig(TableConfig value)
TableFeaturesBuilder	setMaxEntries(Long value)
TableFeaturesBuilder	setMetadataMatch(BigInteger value)
TableFeaturesBuilder	setMetadataWrite(BigInteger value)
TableFeaturesBuilder	setName(String value)
TableFeaturesBuilder	setTableId(Short value)
TableFeaturesBuilder	setTableProperties(TableProperties value)
TableFeaturesBuilder	withKey(TableFeaturesKey key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableFeaturesBuilder

public TableFeaturesBuilder()

TableFeaturesBuilder

public TableFeaturesBuilder(TableFeatures base)

Method Detail

key

public TableFeaturesKey key()

getConfig

public TableConfig getConfig()

getMaxEntries

public Long getMaxEntries()

getMetadataMatch

public BigInteger getMetadataMatch()

getMetadataWrite

public BigInteger getMetadataWrite()

getName

public String getName()

getTableId

public Short getTableId()

getTableProperties

public TableProperties getTableProperties()

augmentation

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

withKey

public TableFeaturesBuilder withKey(TableFeaturesKey key)

setConfig

public TableFeaturesBuilder setConfig(TableConfig value)

setMaxEntries

public TableFeaturesBuilder setMaxEntries(Long value)

setMetadataMatch

public TableFeaturesBuilder setMetadataMatch(BigInteger value)

setMetadataWrite

public TableFeaturesBuilder setMetadataWrite(BigInteger value)

setName

public TableFeaturesBuilder setName(String value)

setTableId

public TableFeaturesBuilder setTableId(Short value)

setTableProperties

public TableFeaturesBuilder setTableProperties(TableProperties value)

addAugmentation

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

removeAugmentation

public TableFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> augmentationType)

build

public TableFeatures build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<TableFeatures,IllegalArgumentException>