Class GroupStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.statistics.reply.GroupStatsBuilder
-
@Generated("mdsal-binding-generator") public class GroupStatsBuilder extends Object
Class that buildsGroupStats
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:
GroupStats createGroupStats(int fooXyzzy, int barBaz) { return new GroupStatsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupStats, 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:
GroupStats
- 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 GroupStatsBuilder()
Construct an empty builder.GroupStatsBuilder(GroupStats base)
Construct a builder initialized with state from specifiedGroupStats
.GroupStatsBuilder(GroupStatistics arg)
Construct a new builder initialized from specifiedGroupStatistics
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupStatsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupStats> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStats>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull GroupStats
build()
A newGroupStats
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Buckets
getBuckets()
Return current value associated with the property corresponding toGroupStatistics.getBuckets()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getByteCount()
Return current value associated with the property corresponding toGroupStatistics.getByteCount()
.Duration
getDuration()
Return current value associated with the property corresponding toGroupStatistics.getDuration()
.GroupId
getGroupId()
Return current value associated with the property corresponding toGroupStatistics.getGroupId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketCount()
Return current value associated with the property corresponding toGroupStatistics.getPacketCount()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
getRefCount()
Return current value associated with the property corresponding toGroupStatistics.getRefCount()
.GroupStatsKey
key()
Return current value associated with the property corresponding toGroupStats.key()
.GroupStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStats>> augmentationType)
Remove an augmentation from this builder's product.GroupStatsBuilder
setBuckets(Buckets value)
Set the property corresponding toGroupStatistics.getBuckets()
to the specified value.GroupStatsBuilder
setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toGroupStatistics.getByteCount()
to the specified value.GroupStatsBuilder
setDuration(Duration value)
Set the property corresponding toGroupStatistics.getDuration()
to the specified value.GroupStatsBuilder
setGroupId(GroupId value)
Set the property corresponding toGroupStatistics.getGroupId()
to the specified value.GroupStatsBuilder
setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toGroupStatistics.getPacketCount()
to the specified value.GroupStatsBuilder
setRefCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
Set the property corresponding toGroupStatistics.getRefCount()
to the specified value.GroupStatsBuilder
withKey(GroupStatsKey key)
-
-
-
Constructor Detail
-
GroupStatsBuilder
public GroupStatsBuilder()
Construct an empty builder.
-
GroupStatsBuilder
public GroupStatsBuilder(GroupStatistics arg)
Construct a new builder initialized from specifiedGroupStatistics
.- Parameters:
arg
- GroupStatistics from which the builder should be initialized
-
GroupStatsBuilder
public GroupStatsBuilder(GroupStats base)
Construct a builder initialized with state from specifiedGroupStats
.- Parameters:
base
- GroupStats 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
-
key
public GroupStatsKey key()
Return current value associated with the property corresponding toGroupStats.key()
.- Returns:
- current value
-
getBuckets
public Buckets getBuckets()
Return current value associated with the property corresponding toGroupStatistics.getBuckets()
.- Returns:
- current value
-
getByteCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()
Return current value associated with the property corresponding toGroupStatistics.getByteCount()
.- Returns:
- current value
-
getDuration
public Duration getDuration()
Return current value associated with the property corresponding toGroupStatistics.getDuration()
.- Returns:
- current value
-
getGroupId
public GroupId getGroupId()
Return current value associated with the property corresponding toGroupStatistics.getGroupId()
.- Returns:
- current value
-
getPacketCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()
Return current value associated with the property corresponding toGroupStatistics.getPacketCount()
.- Returns:
- current value
-
getRefCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getRefCount()
Return current value associated with the property corresponding toGroupStatistics.getRefCount()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStats>> 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
-
withKey
public GroupStatsBuilder withKey(GroupStatsKey key)
-
setBuckets
public GroupStatsBuilder setBuckets(Buckets value)
Set the property corresponding toGroupStatistics.getBuckets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setByteCount
public GroupStatsBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toGroupStatistics.getByteCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDuration
public GroupStatsBuilder setDuration(Duration value)
Set the property corresponding toGroupStatistics.getDuration()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupId
public GroupStatsBuilder setGroupId(GroupId value)
Set the property corresponding toGroupStatistics.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketCount
public GroupStatsBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
Set the property corresponding toGroupStatistics.getPacketCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRefCount
public GroupStatsBuilder setRefCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
Set the property corresponding toGroupStatistics.getRefCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GroupStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupStats> 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 GroupStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStats>> 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 GroupStats build()
A newGroupStats
instance.- Returns:
- A new
GroupStats
instance.
-
-