Class PacketsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.node.connector.statistics.PacketsBuilder
Class that builds
Packets
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:
Packets createPackets(int fooXyzzy, int barBaz) {
return new PacketsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Packets, 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
ConstructorDescriptionConstruct an empty builder.PacketsBuilder
(Packets base) Construct a builder initialized with state from specifiedPackets
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Packets> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Packets
build()
A newPackets
instance.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toPackets.getReceived()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toPackets.getTransmitted()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> augmentationType) Remove an augmentation from this builder's product.setReceived
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toPackets.getReceived()
to the specified value.setTransmitted
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toPackets.getTransmitted()
to the specified value.
-
Constructor Details
-
PacketsBuilder
public PacketsBuilder()Construct an empty builder. -
PacketsBuilder
Construct a builder initialized with state from specifiedPackets
.- Parameters:
base
- Packets from which the builder should be initialized
-
-
Method Details
-
getReceived
public org.opendaylight.yangtools.yang.common.Uint64 getReceived()Return current value associated with the property corresponding toPackets.getReceived()
.- Returns:
- current value
-
getTransmitted
public org.opendaylight.yangtools.yang.common.Uint64 getTransmitted()Return current value associated with the property corresponding toPackets.getTransmitted()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> 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
-
setReceived
Set the property corresponding toPackets.getReceived()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransmitted
Set the property corresponding toPackets.getTransmitted()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PacketsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Packets> 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 PacketsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> 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 newPackets
instance.- Returns:
- A new
Packets
instance.
-