Class GetGroupStatisticsInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.GetGroupStatisticsInputBuilder
-
@Generated("mdsal-binding-generator") public class GetGroupStatisticsInputBuilder extends Object
Class that buildsGetGroupStatisticsInput
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:
GetGroupStatisticsInput createGetGroupStatisticsInput(int fooXyzzy, int barBaz) { return new GetGroupStatisticsInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetGroupStatisticsInput, 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:
GetGroupStatisticsInput
- 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 GetGroupStatisticsInputBuilder()
Construct an empty builder.GetGroupStatisticsInputBuilder(GetGroupStatisticsInput base)
Construct a builder initialized with state from specifiedGetGroupStatisticsInput
.GetGroupStatisticsInputBuilder(StatsInputCommonGrouping arg)
Construct a new builder initialized from specifiedStatsInputCommonGrouping
.GetGroupStatisticsInputBuilder(StoreStatsGrouping arg)
Construct a new builder initialized from specifiedStoreStatsGrouping
.GetGroupStatisticsInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetGroupStatisticsInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull GetGroupStatisticsInput
build()
A newGetGroupStatisticsInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.GroupId
getGroupId()
Return current value associated with the property corresponding toGetGroupStatisticsInput.getGroupId()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.Boolean
getStoreStats()
Return current value associated with the property corresponding toStoreStatsGrouping.getStoreStats()
.GetGroupStatisticsInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsInput>> augmentationType)
Remove an augmentation from this builder's product.GetGroupStatisticsInputBuilder
setGroupId(GroupId value)
Set the property corresponding toGetGroupStatisticsInput.getGroupId()
to the specified value.GetGroupStatisticsInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.GetGroupStatisticsInputBuilder
setStoreStats(Boolean value)
Set the property corresponding toStoreStatsGrouping.getStoreStats()
to the specified value.
-
-
-
Constructor Detail
-
GetGroupStatisticsInputBuilder
public GetGroupStatisticsInputBuilder()
Construct an empty builder.
-
GetGroupStatisticsInputBuilder
public GetGroupStatisticsInputBuilder(StatsInputCommonGrouping arg)
Construct a new builder initialized from specifiedStatsInputCommonGrouping
.- Parameters:
arg
- StatsInputCommonGrouping from which the builder should be initialized
-
GetGroupStatisticsInputBuilder
public GetGroupStatisticsInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
GetGroupStatisticsInputBuilder
public GetGroupStatisticsInputBuilder(StoreStatsGrouping arg)
Construct a new builder initialized from specifiedStoreStatsGrouping
.- Parameters:
arg
- StoreStatsGrouping from which the builder should be initialized
-
GetGroupStatisticsInputBuilder
public GetGroupStatisticsInputBuilder(GetGroupStatisticsInput base)
Construct a builder initialized with state from specifiedGetGroupStatisticsInput
.- Parameters:
base
- GetGroupStatisticsInput 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
-
getGroupId
public GroupId getGroupId()
Return current value associated with the property corresponding toGetGroupStatisticsInput.getGroupId()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getStoreStats
public Boolean getStoreStats()
Return current value associated with the property corresponding toStoreStatsGrouping.getStoreStats()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsInput>> 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
-
setGroupId
public GetGroupStatisticsInputBuilder setGroupId(GroupId value)
Set the property corresponding toGetGroupStatisticsInput.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public GetGroupStatisticsInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStoreStats
public GetGroupStatisticsInputBuilder setStoreStats(Boolean value)
Set the property corresponding toStoreStatsGrouping.getStoreStats()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GetGroupStatisticsInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsInput> 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 GetGroupStatisticsInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsInput>> 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 GetGroupStatisticsInput build()
A newGetGroupStatisticsInput
instance.- Returns:
- A new
GetGroupStatisticsInput
instance.
-
-