Class TableFeaturesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesBuilder
-
@Generated("mdsal-binding-generator") public class TableFeaturesBuilder extends Object
Class that buildsTableFeatures
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:
TableFeatures createTableFeatures(int fooXyzzy, int barBaz) { return new TableFeaturesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TableFeatures, 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:
TableFeatures
- 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
-
-
Constructor Summary
Constructors Constructor Description TableFeaturesBuilder()
Construct an empty builder.TableFeaturesBuilder(TableFeatures base)
Construct a builder initialized with state from specifiedTableFeatures
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TableFeaturesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TableFeatures
build()
A newTableFeatures
instance.TableConfig
getConfig()
Return current value associated with the property corresponding toTableFeatures.getConfig()
.org.opendaylight.yangtools.yang.common.Uint32
getMaxEntries()
Return current value associated with the property corresponding toTableFeatures.getMaxEntries()
.org.opendaylight.yangtools.yang.common.Uint64
getMetadataMatch()
Return current value associated with the property corresponding toTableFeatures.getMetadataMatch()
.org.opendaylight.yangtools.yang.common.Uint64
getMetadataWrite()
Return current value associated with the property corresponding toTableFeatures.getMetadataWrite()
.String
getName()
Return current value associated with the property corresponding toTableFeatures.getName()
.org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Return current value associated with the property corresponding toTableFeatures.getTableId()
.TableProperties
getTableProperties()
Return current value associated with the property corresponding toTableFeatures.getTableProperties()
.TableFeaturesKey
key()
Return current value associated with the property corresponding toTableFeatures.key()
.TableFeaturesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> augmentationType)
Remove an augmentation from this builder's product.TableFeaturesBuilder
setConfig(TableConfig value)
Set the property corresponding toTableFeatures.getConfig()
to the specified value.TableFeaturesBuilder
setMaxEntries(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toTableFeatures.getMaxEntries()
to the specified value.TableFeaturesBuilder
setMetadataMatch(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toTableFeatures.getMetadataMatch()
to the specified value.TableFeaturesBuilder
setMetadataWrite(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toTableFeatures.getMetadataWrite()
to the specified value.TableFeaturesBuilder
setName(String value)
Set the property corresponding toTableFeatures.getName()
to the specified value.TableFeaturesBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toTableFeatures.getTableId()
to the specified value.TableFeaturesBuilder
setTableProperties(TableProperties value)
Set the property corresponding toTableFeatures.getTableProperties()
to the specified value.TableFeaturesBuilder
withKey(TableFeaturesKey key)
-
-
-
Constructor Detail
-
TableFeaturesBuilder
public TableFeaturesBuilder()
Construct an empty builder.
-
TableFeaturesBuilder
public TableFeaturesBuilder(TableFeatures base)
Construct a builder initialized with state from specifiedTableFeatures
.- Parameters:
base
- TableFeatures from which the builder should be initialized
-
-
Method Detail
-
key
public TableFeaturesKey key()
Return current value associated with the property corresponding toTableFeatures.key()
.- Returns:
- current value
-
getConfig
public TableConfig getConfig()
Return current value associated with the property corresponding toTableFeatures.getConfig()
.- Returns:
- current value
-
getMaxEntries
public org.opendaylight.yangtools.yang.common.Uint32 getMaxEntries()
Return current value associated with the property corresponding toTableFeatures.getMaxEntries()
.- Returns:
- current value
-
getMetadataMatch
public org.opendaylight.yangtools.yang.common.Uint64 getMetadataMatch()
Return current value associated with the property corresponding toTableFeatures.getMetadataMatch()
.- Returns:
- current value
-
getMetadataWrite
public org.opendaylight.yangtools.yang.common.Uint64 getMetadataWrite()
Return current value associated with the property corresponding toTableFeatures.getMetadataWrite()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toTableFeatures.getName()
.- Returns:
- current value
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
Return current value associated with the property corresponding toTableFeatures.getTableId()
.- Returns:
- current value
-
getTableProperties
public TableProperties getTableProperties()
Return current value associated with the property corresponding toTableFeatures.getTableProperties()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> 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
- ifaugmentType
isnull
-
withKey
public TableFeaturesBuilder withKey(TableFeaturesKey key)
-
setConfig
public TableFeaturesBuilder setConfig(TableConfig value)
Set the property corresponding toTableFeatures.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxEntries
public TableFeaturesBuilder setMaxEntries(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toTableFeatures.getMaxEntries()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetadataMatch
public TableFeaturesBuilder setMetadataMatch(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toTableFeatures.getMetadataMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetadataWrite
public TableFeaturesBuilder setMetadataWrite(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toTableFeatures.getMetadataWrite()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public TableFeaturesBuilder setName(String value)
Set the property corresponding toTableFeatures.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public TableFeaturesBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toTableFeatures.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableProperties
public TableFeaturesBuilder setTableProperties(TableProperties value)
Set the property corresponding toTableFeatures.getTableProperties()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TableFeaturesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public TableFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> 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 TableFeatures build()
A newTableFeatures
instance.- Returns:
- A new
TableFeatures
instance.
-
-