Class VlanStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanStatsBuilder
-
@Generated("mdsal-binding-generator") public class VlanStatsBuilder extends Object
Class that buildsVlanStats
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:
VlanStats createVlanStats(int fooXyzzy, int barBaz) { return new VlanStatsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VlanStats, 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:
VlanStats
- 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 VlanStatsBuilder()
Construct an empty builder.VlanStatsBuilder(VlanStats base)
Construct a builder initialized with state from specifiedVlanStats
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VlanStatsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VlanStats> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanStats>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull VlanStats
build()
A newVlanStats
instance.org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
getVlanStatsKey()
Return current value associated with the property corresponding toVlanStats.getVlanStatsKey()
.HwvtepLogicalBindingStatsRef
getVlanStatsRef()
Return current value associated with the property corresponding toVlanStats.getVlanStatsRef()
.VlanStatsKey
key()
Return current value associated with the property corresponding toVlanStats.key()
.VlanStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanStats>> augmentationType)
Remove an augmentation from this builder's product.VlanStatsBuilder
setVlanStatsKey(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
Set the property corresponding toVlanStats.getVlanStatsKey()
to the specified value.VlanStatsBuilder
setVlanStatsRef(HwvtepLogicalBindingStatsRef value)
Set the property corresponding toVlanStats.getVlanStatsRef()
to the specified value.VlanStatsBuilder
withKey(VlanStatsKey key)
-
-
-
Method Detail
-
key
public VlanStatsKey key()
Return current value associated with the property corresponding toVlanStats.key()
.- Returns:
- current value
-
getVlanStatsKey
public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanStatsKey()
Return current value associated with the property corresponding toVlanStats.getVlanStatsKey()
.- Returns:
- current value
-
getVlanStatsRef
public HwvtepLogicalBindingStatsRef getVlanStatsRef()
Return current value associated with the property corresponding toVlanStats.getVlanStatsRef()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanStats>> 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
-
withKey
public VlanStatsBuilder withKey(VlanStatsKey key)
-
setVlanStatsKey
public VlanStatsBuilder setVlanStatsKey(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
Set the property corresponding toVlanStats.getVlanStatsKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVlanStatsRef
public VlanStatsBuilder setVlanStatsRef(HwvtepLogicalBindingStatsRef value)
Set the property corresponding toVlanStats.getVlanStatsRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public VlanStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VlanStats> 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 VlanStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanStats>> 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
-
-