Package org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.table.features
Class TablePropertiesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.table.features.TablePropertiesBuilder
-
@Generated("mdsal-binding-generator") public class TablePropertiesBuilder extends Object
Class that buildsTableProperties
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:
TableProperties createTableProperties(int fooXyzzy, int barBaz) { return new TablePropertiesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TableProperties, 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:
TableProperties
- 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 TablePropertiesBuilder()
Construct an empty builder.TablePropertiesBuilder(TableProperties base)
Construct a builder initialized with state from specifiedTableProperties
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TablePropertiesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableProperties> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableProperties>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TableProperties
build()
A newTableProperties
instance.Map<TableFeaturePropertiesKey,TableFeatureProperties>
getTableFeatureProperties()
Return current value associated with the property corresponding toTableProperties.getTableFeatureProperties()
.TablePropertiesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableProperties>> augmentationType)
Remove an augmentation from this builder's product.TablePropertiesBuilder
setTableFeatureProperties(Map<TableFeaturePropertiesKey,TableFeatureProperties> values)
Set the property corresponding toTableProperties.getTableFeatureProperties()
to the specified value.
-
-
-
Constructor Detail
-
TablePropertiesBuilder
public TablePropertiesBuilder()
Construct an empty builder.
-
TablePropertiesBuilder
public TablePropertiesBuilder(TableProperties base)
Construct a builder initialized with state from specifiedTableProperties
.- Parameters:
base
- TableProperties from which the builder should be initialized
-
-
Method Detail
-
getTableFeatureProperties
public Map<TableFeaturePropertiesKey,TableFeatureProperties> getTableFeatureProperties()
Return current value associated with the property corresponding toTableProperties.getTableFeatureProperties()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableProperties>> 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
-
setTableFeatureProperties
public TablePropertiesBuilder setTableFeatureProperties(Map<TableFeaturePropertiesKey,TableFeatureProperties> values)
Set the property corresponding toTableProperties.getTableFeatureProperties()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public TablePropertiesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableProperties> 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 TablePropertiesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableProperties>> 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 TableProperties build()
A newTableProperties
instance.- Returns:
- A new
TableProperties
instance.
-
-