Class QueueStatsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStatsBuilder
Class that builds
QueueStats
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:
QueueStats createQueueStats(int fooXyzzy, int barBaz) {
return new QueueStatsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of QueueStats, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.QueueStatsBuilder
(QueueStats base) Construct a builder initialized with state from specifiedQueueStats
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<QueueStats> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStats>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull QueueStats
build()
A newQueueStats
instance.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toQueueStats.getDurationNsec()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toQueueStats.getDurationSec()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toQueueStats.getPortNo()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toQueueStats.getQueueId()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toQueueStats.getTxBytes()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toQueueStats.getTxErrors()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toQueueStats.getTxPackets()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStats>> augmentationType) Remove an augmentation from this builder's product.setDurationNsec
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toQueueStats.getDurationNsec()
to the specified value.setDurationSec
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toQueueStats.getDurationSec()
to the specified value.setPortNo
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toQueueStats.getPortNo()
to the specified value.setQueueId
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toQueueStats.getQueueId()
to the specified value.setTxBytes
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toQueueStats.getTxBytes()
to the specified value.setTxErrors
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toQueueStats.getTxErrors()
to the specified value.setTxPackets
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toQueueStats.getTxPackets()
to the specified value.
-
Constructor Details
-
QueueStatsBuilder
public QueueStatsBuilder()Construct an empty builder. -
QueueStatsBuilder
Construct a builder initialized with state from specifiedQueueStats
.- Parameters:
base
- QueueStats from which the builder should be initialized
-
-
Method Details
-
getDurationNsec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()Return current value associated with the property corresponding toQueueStats.getDurationNsec()
.- Returns:
- current value
-
getDurationSec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()Return current value associated with the property corresponding toQueueStats.getDurationSec()
.- Returns:
- current value
-
getPortNo
public org.opendaylight.yangtools.yang.common.Uint32 getPortNo()Return current value associated with the property corresponding toQueueStats.getPortNo()
.- Returns:
- current value
-
getQueueId
public org.opendaylight.yangtools.yang.common.Uint32 getQueueId()Return current value associated with the property corresponding toQueueStats.getQueueId()
.- Returns:
- current value
-
getTxBytes
public org.opendaylight.yangtools.yang.common.Uint64 getTxBytes()Return current value associated with the property corresponding toQueueStats.getTxBytes()
.- Returns:
- current value
-
getTxErrors
public org.opendaylight.yangtools.yang.common.Uint64 getTxErrors()Return current value associated with the property corresponding toQueueStats.getTxErrors()
.- Returns:
- current value
-
getTxPackets
public org.opendaylight.yangtools.yang.common.Uint64 getTxPackets()Return current value associated with the property corresponding toQueueStats.getTxPackets()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStats>> 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
-
setDurationNsec
Set the property corresponding toQueueStats.getDurationNsec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDurationSec
Set the property corresponding toQueueStats.getDurationSec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPortNo
Set the property corresponding toQueueStats.getPortNo()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setQueueId
Set the property corresponding toQueueStats.getQueueId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTxBytes
Set the property corresponding toQueueStats.getTxBytes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTxErrors
Set the property corresponding toQueueStats.getTxErrors()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTxPackets
Set the property corresponding toQueueStats.getTxPackets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public QueueStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<QueueStats> 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 QueueStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QueueStats>> 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
A newQueueStats
instance.- Returns:
- A new
QueueStats
instance.
-