Class TableFeaturePropertiesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.table.features.table.properties.TableFeaturePropertiesBuilder
-
@Generated("mdsal-binding-generator") public class TableFeaturePropertiesBuilder extends Object
Class that buildsTableFeatureProperties
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:
TableFeatureProperties createTableFeatureProperties(int fooXyzzy, int barBaz) { return new TableFeaturePropertiesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TableFeatureProperties, 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:
TableFeatureProperties
- 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 TableFeaturePropertiesBuilder()
Construct an empty builder.TableFeaturePropertiesBuilder(Ordered arg)
Construct a new builder initialized from specifiedOrdered
.TableFeaturePropertiesBuilder(TableFeatureProperties base)
Construct a builder initialized with state from specifiedTableFeatureProperties
.TableFeaturePropertiesBuilder(TableFeaturePropType arg)
Construct a new builder initialized from specifiedTableFeaturePropType
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TableFeaturePropertiesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TableFeatureProperties
build()
A newTableFeatureProperties
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Integer
getOrder()
Return current value associated with the property corresponding toOrdered.getOrder()
.TableFeaturePropType
getTableFeaturePropType()
Return current value associated with the property corresponding toTableFeaturePropType.getTableFeaturePropType()
.TableFeaturePropertiesKey
key()
Return current value associated with the property corresponding toTableFeatureProperties.key()
.TableFeaturePropertiesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> augmentationType)
Remove an augmentation from this builder's product.TableFeaturePropertiesBuilder
setOrder(Integer value)
Set the property corresponding toOrdered.getOrder()
to the specified value.TableFeaturePropertiesBuilder
setTableFeaturePropType(TableFeaturePropType value)
Set the property corresponding toTableFeaturePropType.getTableFeaturePropType()
to the specified value.TableFeaturePropertiesBuilder
withKey(TableFeaturePropertiesKey key)
-
-
-
Constructor Detail
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder()
Construct an empty builder.
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder(Ordered arg)
Construct a new builder initialized from specifiedOrdered
.- Parameters:
arg
- Ordered from which the builder should be initialized
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder(TableFeaturePropType arg)
Construct a new builder initialized from specifiedTableFeaturePropType
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeaturePropType from which the builder should be initialized
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder(TableFeatureProperties base)
Construct a builder initialized with state from specifiedTableFeatureProperties
.- Parameters:
base
- TableFeatureProperties from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public TableFeaturePropertiesKey key()
Return current value associated with the property corresponding toTableFeatureProperties.key()
.- Returns:
- current value
-
getOrder
public Integer getOrder()
Return current value associated with the property corresponding toOrdered.getOrder()
.- Returns:
- current value
-
getTableFeaturePropType
public TableFeaturePropType getTableFeaturePropType()
Return current value associated with the property corresponding toTableFeaturePropType.getTableFeaturePropType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> 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 TableFeaturePropertiesBuilder withKey(TableFeaturePropertiesKey key)
-
setOrder
public TableFeaturePropertiesBuilder setOrder(Integer value)
Set the property corresponding toOrdered.getOrder()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableFeaturePropType
public TableFeaturePropertiesBuilder setTableFeaturePropType(TableFeaturePropType value)
Set the property corresponding toTableFeaturePropType.getTableFeaturePropType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TableFeaturePropertiesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties> 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 TableFeaturePropertiesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> 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 TableFeatureProperties build()
A newTableFeatureProperties
instance.- Returns:
- A new
TableFeatureProperties
instance.
-
-