Class GetGroupStatisticsOutputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupStatisticsOutputBuilder
Class that builds
GetGroupStatisticsOutput
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:
GetGroupStatisticsOutput createGetGroupStatisticsOutput(int fooXyzzy, int barBaz) {
return new GetGroupStatisticsOutputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GetGroupStatisticsOutput, 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 specifiedTransactionAware
.Construct a builder initialized with state from specifiedGetGroupStatisticsOutput
.Construct a new builder initialized from specifiedGroupStatisticsReply
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull GetGroupStatisticsOutput
build()
A newGetGroupStatisticsOutput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toGroupStatisticsReply.getGroupStats()
.Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput>> augmentationType) Remove an augmentation from this builder's product.setGroupStats
(Map<GroupStatsKey, GroupStats> values) Set the property corresponding toGroupStatisticsReply.getGroupStats()
to the specified value.setTransactionId
(TransactionId value) Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.
-
Constructor Details
-
GetGroupStatisticsOutputBuilder
public GetGroupStatisticsOutputBuilder()Construct an empty builder. -
GetGroupStatisticsOutputBuilder
Construct a new builder initialized from specifiedGroupStatisticsReply
.- Parameters:
arg
- GroupStatisticsReply from which the builder should be initialized
-
GetGroupStatisticsOutputBuilder
Construct a new builder initialized from specifiedTransactionAware
.- Parameters:
arg
- TransactionAware from which the builder should be initialized
-
GetGroupStatisticsOutputBuilder
Construct a builder initialized with state from specifiedGetGroupStatisticsOutput
.- Parameters:
base
- GetGroupStatisticsOutput 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
-
getGroupStats
Return current value associated with the property corresponding toGroupStatisticsReply.getGroupStats()
.- 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<GetGroupStatisticsOutput>> 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
-
setGroupStats
Set the property corresponding toGroupStatisticsReply.getGroupStats()
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 GetGroupStatisticsOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput> 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 GetGroupStatisticsOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput>> 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 newGetGroupStatisticsOutput
instance.- Returns:
- A new
GetGroupStatisticsOutput
instance.
-