Class GetGroupStatisticsOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.GetGroupStatisticsOutputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GetGroupStatisticsOutput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GetGroupStatisticsOutput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class GetGroupStatisticsOutputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GetGroupStatisticsOutput>
Class that buildsGetGroupStatisticsOutputBuilder
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:
GetGroupStatisticsOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new GetGroupStatisticsOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetGroupStatisticsOutputBuilder, 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 oportunities, 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:
GetGroupStatisticsOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GetGroupStatisticsOutputBuilder()
GetGroupStatisticsOutputBuilder(GetGroupStatisticsOutput base)
GetGroupStatisticsOutputBuilder(GroupStatisticsReply arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GetGroupStatisticsOutputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.GetGroupStatisticsOutputBuilder
addAugmentation(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)
GetGroupStatisticsOutput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<GroupStatsKey,GroupStats>
getGroupStats()
GetGroupStatisticsOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput>> augmentationType)
Remove an augmentation from this builder's product.GetGroupStatisticsOutputBuilder
setGroupStats(List<GroupStats> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetGroupStats(Map)
instead.GetGroupStatisticsOutputBuilder
setGroupStats(Map<GroupStatsKey,GroupStats> values)
-
-
-
Constructor Detail
-
GetGroupStatisticsOutputBuilder
public GetGroupStatisticsOutputBuilder()
-
GetGroupStatisticsOutputBuilder
public GetGroupStatisticsOutputBuilder(GroupStatisticsReply arg)
-
GetGroupStatisticsOutputBuilder
public GetGroupStatisticsOutputBuilder(GetGroupStatisticsOutput base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupStatisticsReply
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getGroupStats
public Map<GroupStatsKey,GroupStats> getGroupStats()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
setGroupStats
public GetGroupStatisticsOutputBuilder setGroupStats(Map<GroupStatsKey,GroupStats> values)
-
setGroupStats
@Deprecated(forRemoval=true) public GetGroupStatisticsOutputBuilder setGroupStats(List<GroupStats> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetGroupStats(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public GetGroupStatisticsOutputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupStatisticsOutput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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
public GetGroupStatisticsOutput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GetGroupStatisticsOutput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GetGroupStatisticsOutput,IllegalArgumentException>
-
-