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