Class PacketsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.node.connector.statistics.PacketsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Packets>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Packets,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PacketsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Packets>
Class that buildsPacketsBuilder
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:
PacketsBuilder createTarget(int fooXyzzy, int barBaz) { return new PacketsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketsBuilder, 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 oportunities, 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:
PacketsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketsBuilder()
PacketsBuilder(Packets base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PacketsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Packets> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>>
E$$augmentation(Class<E$$> augmentationType)
Packets
build()
org.opendaylight.yangtools.yang.common.Uint64
getReceived()
org.opendaylight.yangtools.yang.common.Uint64
getTransmitted()
PacketsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> augmentationType)
PacketsBuilder
setReceived(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setReceived(Uint64)} instead.PacketsBuilder
setReceived(org.opendaylight.yangtools.yang.common.Uint64 value)
PacketsBuilder
setTransmitted(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTransmitted(Uint64)} instead.PacketsBuilder
setTransmitted(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
PacketsBuilder
public PacketsBuilder()
-
PacketsBuilder
public PacketsBuilder(Packets base)
-
-
Method Detail
-
getReceived
public org.opendaylight.yangtools.yang.common.Uint64 getReceived()
-
getTransmitted
public org.opendaylight.yangtools.yang.common.Uint64 getTransmitted()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> E$$ augmentation(Class<E$$> augmentationType)
-
setReceived
public PacketsBuilder setReceived(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setReceived
@Deprecated(forRemoval=true) public PacketsBuilder setReceived(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setReceived(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTransmitted
public PacketsBuilder setTransmitted(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setTransmitted
@Deprecated(forRemoval=true) public PacketsBuilder setTransmitted(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTransmitted(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public PacketsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Packets> augmentationValue)
-
removeAugmentation
public PacketsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> augmentationType)
-
build
public Packets build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Packets>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Packets,IllegalArgumentException>
-
-