Class TableUpdatedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.TableUpdatedBuilder
-
@Generated("mdsal-binding-generator") public class TableUpdatedBuilder extends Object
Class that buildsTableUpdated
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:
TableUpdated createTableUpdated(int fooXyzzy, int barBaz) { return new TableUpdatedBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TableUpdated, 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:
TableUpdated
- 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 TableUpdatedBuilder()
Construct an empty builder.TableUpdatedBuilder(MultipartTransactionAware arg)
Construct a new builder initialized from specifiedMultipartTransactionAware
.TableUpdatedBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.TableUpdatedBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.TableUpdatedBuilder(TableUpdated base)
Construct a builder initialized with state from specifiedTableUpdated
.TableUpdatedBuilder(TableFeatures arg)
Construct a new builder initialized from specifiedTableFeatures
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TableUpdatedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableUpdated> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableUpdated>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TableUpdated
build()
A newTableUpdated
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getMoreReplies()
Return current value associated with the property corresponding toMultipartTransactionAware.getMoreReplies()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.Map<TableFeaturesKey,TableFeatures>
getTableFeatures()
Return current value associated with the property corresponding toTableFeatures.getTableFeatures()
.TransactionId
getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.TableUpdatedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableUpdated>> augmentationType)
Remove an augmentation from this builder's product.TableUpdatedBuilder
setMoreReplies(Boolean value)
Set the property corresponding toMultipartTransactionAware.getMoreReplies()
to the specified value.TableUpdatedBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.TableUpdatedBuilder
setTableFeatures(Map<TableFeaturesKey,TableFeatures> values)
Set the property corresponding toTableFeatures.getTableFeatures()
to the specified value.TableUpdatedBuilder
setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.
-
-
-
Constructor Detail
-
TableUpdatedBuilder
public TableUpdatedBuilder()
Construct an empty builder.
-
TableUpdatedBuilder
public TableUpdatedBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
TableUpdatedBuilder
public TableUpdatedBuilder(MultipartTransactionAware arg)
Construct a new builder initialized from specifiedMultipartTransactionAware
.- Parameters:
arg
- MultipartTransactionAware from which the builder should be initialized
-
TableUpdatedBuilder
public TableUpdatedBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.- Parameters:
arg
- TransactionAware from which the builder should be initialized
-
TableUpdatedBuilder
public TableUpdatedBuilder(TableFeatures arg)
Construct a new builder initialized from specifiedTableFeatures
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures from which the builder should be initialized
-
TableUpdatedBuilder
public TableUpdatedBuilder(TableUpdated base)
Construct a builder initialized with state from specifiedTableUpdated
.- Parameters:
base
- TableUpdated 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
-
getMoreReplies
public Boolean getMoreReplies()
Return current value associated with the property corresponding toMultipartTransactionAware.getMoreReplies()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getTableFeatures
public Map<TableFeaturesKey,TableFeatures> getTableFeatures()
Return current value associated with the property corresponding toTableFeatures.getTableFeatures()
.- Returns:
- current value
-
getTransactionId
public TransactionId getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableUpdated>> 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
-
setMoreReplies
public TableUpdatedBuilder setMoreReplies(Boolean value)
Set the property corresponding toMultipartTransactionAware.getMoreReplies()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public TableUpdatedBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableFeatures
public TableUpdatedBuilder setTableFeatures(Map<TableFeaturesKey,TableFeatures> values)
Set the property corresponding toTableFeatures.getTableFeatures()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setTransactionId
public TableUpdatedBuilder setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TableUpdatedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableUpdated> 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 TableUpdatedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableUpdated>> 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 TableUpdated build()
A newTableUpdated
instance.- Returns:
- A new
TableUpdated
instance.
-
-