Class GroupStatisticsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.statistics.GroupStatisticsBuilder
-
@Generated("mdsal-binding-generator") public class GroupStatisticsBuilder extends Object
Class that buildsGroupStatistics
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:
GroupStatistics createGroupStatistics(int fooXyzzy, int barBaz) { return new GroupStatisticsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupStatistics, 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:
GroupStatistics
- 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 GroupStatisticsBuilder()
Construct an empty builder.GroupStatisticsBuilder(GroupStatistics base)
Construct a builder initialized with state from specifiedGroupStatistics
.GroupStatisticsBuilder(GroupStatistics arg)
Construct a new builder initialized from specifiedGroupStatistics
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupStatisticsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupStatistics> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStatistics>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull GroupStatistics
build()
A newGroupStatistics
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()
.GroupStatisticsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStatistics>> augmentationType)
Remove an augmentation from this builder's product.GroupStatisticsBuilder
setBuckets(Buckets value)
Set the property corresponding toGroupStatistics.getBuckets()
to the specified value.GroupStatisticsBuilder
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.GroupStatisticsBuilder
setDuration(Duration value)
Set the property corresponding toGroupStatistics.getDuration()
to the specified value.GroupStatisticsBuilder
setGroupId(GroupId value)
Set the property corresponding toGroupStatistics.getGroupId()
to the specified value.GroupStatisticsBuilder
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.GroupStatisticsBuilder
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.
-
-
-
Constructor Detail
-
GroupStatisticsBuilder
public GroupStatisticsBuilder()
Construct an empty builder.
-
GroupStatisticsBuilder
public GroupStatisticsBuilder(GroupStatistics arg)
Construct a new builder initialized from specifiedGroupStatistics
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupStatistics from which the builder should be initialized
-
GroupStatisticsBuilder
public GroupStatisticsBuilder(GroupStatistics base)
Construct a builder initialized with state from specifiedGroupStatistics
.- Parameters:
base
- GroupStatistics 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
-
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<GroupStatistics>> 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
-
setBuckets
public GroupStatisticsBuilder setBuckets(Buckets value)
Set the property corresponding toGroupStatistics.getBuckets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setByteCount
public GroupStatisticsBuilder 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 GroupStatisticsBuilder setDuration(Duration value)
Set the property corresponding toGroupStatistics.getDuration()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupId
public GroupStatisticsBuilder setGroupId(GroupId value)
Set the property corresponding toGroupStatistics.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketCount
public GroupStatisticsBuilder 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 GroupStatisticsBuilder 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 GroupStatisticsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupStatistics> 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 GroupStatisticsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStatistics>> 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 GroupStatistics build()
A newGroupStatistics
instance.- Returns:
- A new
GroupStatistics
instance.
-
-