Class GroupStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.statistics.reply.GroupStatsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GroupStats>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GroupStats,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class GroupStatsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GroupStats>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description GroupStatsBuilder()
GroupStatsBuilder(GroupStats base)
GroupStatsBuilder(GroupStatistics arg)
-
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)
GroupStats
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Buckets
getBuckets()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getByteCount()
Duration
getDuration()
GroupId
getGroupId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64
getPacketCount()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
getRefCount()
GroupStatsKey
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)
GroupStatsBuilder
setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
GroupStatsBuilder
setDuration(Duration value)
GroupStatsBuilder
setGroupId(GroupId value)
GroupStatsBuilder
setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
GroupStatsBuilder
setRefCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
GroupStatsBuilder
withKey(GroupStatsKey key)
-
-
-
Constructor Detail
-
GroupStatsBuilder
public GroupStatsBuilder()
-
GroupStatsBuilder
public GroupStatsBuilder(GroupStatistics arg)
-
GroupStatsBuilder
public GroupStatsBuilder(GroupStats 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:- GroupStatistics
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public GroupStatsKey key()
-
getBuckets
public Buckets getBuckets()
-
getByteCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()
-
getDuration
public Duration getDuration()
-
getGroupId
public GroupId getGroupId()
-
getPacketCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()
-
getRefCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getRefCount()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupStats>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public GroupStatsBuilder withKey(GroupStatsKey key)
-
setBuckets
public GroupStatsBuilder setBuckets(Buckets value)
-
setByteCount
public GroupStatsBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
setDuration
public GroupStatsBuilder setDuration(Duration value)
-
setGroupId
public GroupStatsBuilder setGroupId(GroupId value)
-
setPacketCount
public GroupStatsBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
-
setRefCount
public GroupStatsBuilder setRefCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
-
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 GroupStats build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GroupStats>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GroupStats,IllegalArgumentException>
-
-