Class MultipartReplyPortStatsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.multipart.reply.multipart.reply.body.MultipartReplyPortStatsBuilder
Class that builds
MultipartReplyPortStats
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:
MultipartReplyPortStats createMultipartReplyPortStats(int fooXyzzy, int barBaz) {
return new MultipartReplyPortStatsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MultipartReplyPortStats, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedMultipartReplyPortStats
.Construct a new builder initialized from specifiedNodeConnectorStatisticsAndPortNumberMap
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortStats> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortStats>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MultipartReplyPortStats
build()
A newMultipartReplyPortStats
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toNodeConnectorStatisticsAndPortNumberMap.getNodeConnectorStatisticsAndPortNumberMap()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortStats>> augmentationType) Remove an augmentation from this builder's product.setNodeConnectorStatisticsAndPortNumberMap
(Map<NodeConnectorStatisticsAndPortNumberMapKey, NodeConnectorStatisticsAndPortNumberMap> values) Set the property corresponding toNodeConnectorStatisticsAndPortNumberMap.getNodeConnectorStatisticsAndPortNumberMap()
to the specified value.
-
Constructor Details
-
MultipartReplyPortStatsBuilder
public MultipartReplyPortStatsBuilder()Construct an empty builder. -
MultipartReplyPortStatsBuilder
Construct a new builder initialized from specifiedNodeConnectorStatisticsAndPortNumberMap
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.NodeConnectorStatisticsAndPortNumberMap from which the builder should be initialized
-
MultipartReplyPortStatsBuilder
Construct a builder initialized with state from specifiedMultipartReplyPortStats
.- Parameters:
base
- MultipartReplyPortStats 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
-
getNodeConnectorStatisticsAndPortNumberMap
public Map<NodeConnectorStatisticsAndPortNumberMapKey,NodeConnectorStatisticsAndPortNumberMap> getNodeConnectorStatisticsAndPortNumberMap()Return current value associated with the property corresponding toNodeConnectorStatisticsAndPortNumberMap.getNodeConnectorStatisticsAndPortNumberMap()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortStats>> 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
-
setNodeConnectorStatisticsAndPortNumberMap
public MultipartReplyPortStatsBuilder setNodeConnectorStatisticsAndPortNumberMap(Map<NodeConnectorStatisticsAndPortNumberMapKey, NodeConnectorStatisticsAndPortNumberMap> values) Set the property corresponding toNodeConnectorStatisticsAndPortNumberMap.getNodeConnectorStatisticsAndPortNumberMap()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public MultipartReplyPortStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortStats> 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 MultipartReplyPortStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortStats>> 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 newMultipartReplyPortStats
instance.- Returns:
- A new
MultipartReplyPortStats
instance.
-