Class QueueStatisticsUpdateBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.QueueStatisticsUpdateBuilder
Class that builds
QueueStatisticsUpdate
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:
QueueStatisticsUpdate createQueueStatisticsUpdate(int fooXyzzy, int barBaz) {
return new QueueStatisticsUpdateBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of QueueStatisticsUpdate, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedMultipartTransactionAware
.Construct a new builder initialized from specifiedTransactionAware
.Construct a new builder initialized from specifiedNode
.Construct a new builder initialized from specifiedQueueIdAndStatisticsMap
.Construct a builder initialized with state from specifiedQueueStatisticsUpdate
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<QueueStatisticsUpdate> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStatisticsUpdate>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull QueueStatisticsUpdate
build()
A newQueueStatisticsUpdate
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getId()
Return current value associated with the property corresponding toNode.getId()
.Return current value associated with the property corresponding toMultipartTransactionAware.getMoreReplies()
.Return current value associated with the property corresponding toNode.getNodeConnector()
.Return current value associated with the property corresponding toQueueIdAndStatisticsMap.getQueueIdAndStatisticsMap()
.Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStatisticsUpdate>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toNode.getId()
to the specified value.setMoreReplies
(Boolean value) Set the property corresponding toMultipartTransactionAware.getMoreReplies()
to the specified value.setNodeConnector
(Map<NodeConnectorKey, NodeConnector> values) Set the property corresponding toNode.getNodeConnector()
to the specified value.Set the property corresponding toQueueIdAndStatisticsMap.getQueueIdAndStatisticsMap()
to the specified value.setTransactionId
(TransactionId value) Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.
-
Constructor Details
-
QueueStatisticsUpdateBuilder
public QueueStatisticsUpdateBuilder()Construct an empty builder. -
QueueStatisticsUpdateBuilder
Construct a new builder initialized from specifiedNode
.- Parameters:
arg
- Node from which the builder should be initialized
-
QueueStatisticsUpdateBuilder
Construct a new builder initialized from specifiedQueueIdAndStatisticsMap
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.QueueIdAndStatisticsMap from which the builder should be initialized
-
QueueStatisticsUpdateBuilder
Construct a new builder initialized from specifiedMultipartTransactionAware
.- Parameters:
arg
- MultipartTransactionAware from which the builder should be initialized
-
QueueStatisticsUpdateBuilder
Construct a new builder initialized from specifiedTransactionAware
.- Parameters:
arg
- TransactionAware from which the builder should be initialized
-
QueueStatisticsUpdateBuilder
Construct a builder initialized with state from specifiedQueueStatisticsUpdate
.- Parameters:
base
- QueueStatisticsUpdate from which the builder should be initialized
-
-
Method Details
-
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
-
getId
Return current value associated with the property corresponding toNode.getId()
.- Returns:
- current value
-
getMoreReplies
Return current value associated with the property corresponding toMultipartTransactionAware.getMoreReplies()
.- Returns:
- current value
-
getNodeConnector
Return current value associated with the property corresponding toNode.getNodeConnector()
.- Returns:
- current value
-
getQueueIdAndStatisticsMap
Return current value associated with the property corresponding toQueueIdAndStatisticsMap.getQueueIdAndStatisticsMap()
.- Returns:
- current value
-
getTransactionId
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStatisticsUpdate>> 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
-
setId
Set the property corresponding toNode.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMoreReplies
Set the property corresponding toMultipartTransactionAware.getMoreReplies()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNodeConnector
Set the property corresponding toNode.getNodeConnector()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setQueueIdAndStatisticsMap
public QueueStatisticsUpdateBuilder setQueueIdAndStatisticsMap(Map<QueueIdAndStatisticsMapKey, QueueIdAndStatisticsMap> values) Set the property corresponding toQueueIdAndStatisticsMap.getQueueIdAndStatisticsMap()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setTransactionId
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public QueueStatisticsUpdateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<QueueStatisticsUpdate> 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 QueueStatisticsUpdateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStatisticsUpdate>> 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
A newQueueStatisticsUpdate
instance.- Returns:
- A new
QueueStatisticsUpdate
instance.
-