Class VlanVidBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.vlan.vid._case.VlanVidBuilder
-
@Generated("mdsal-binding-generator") public class VlanVidBuilder extends Object
Class that buildsVlanVid
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:
VlanVid createVlanVid(int fooXyzzy, int barBaz) { return new VlanVidBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VlanVid, 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:
VlanVid
- 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 VlanVidBuilder()
Construct an empty builder.VlanVidBuilder(VlanVid base)
Construct a builder initialized with state from specifiedVlanVid
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VlanVidBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull VlanVid
build()
A newVlanVid
instance.Boolean
getCfiBit()
Return current value associated with the property corresponding toVlanVid.getCfiBit()
.byte[]
getMask()
Return current value associated with the property corresponding toVlanVid.getMask()
.org.opendaylight.yangtools.yang.common.Uint16
getVlanVid()
Return current value associated with the property corresponding toVlanVid.getVlanVid()
.VlanVidBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid>> augmentationType)
Remove an augmentation from this builder's product.VlanVidBuilder
setCfiBit(Boolean value)
Set the property corresponding toVlanVid.getCfiBit()
to the specified value.VlanVidBuilder
setMask(byte[] value)
Set the property corresponding toVlanVid.getMask()
to the specified value.VlanVidBuilder
setVlanVid(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toVlanVid.getVlanVid()
to the specified value.
-
-
-
Method Detail
-
getCfiBit
public Boolean getCfiBit()
Return current value associated with the property corresponding toVlanVid.getCfiBit()
.- Returns:
- current value
-
getMask
public byte[] getMask()
Return current value associated with the property corresponding toVlanVid.getMask()
.- Returns:
- current value
-
getVlanVid
public org.opendaylight.yangtools.yang.common.Uint16 getVlanVid()
Return current value associated with the property corresponding toVlanVid.getVlanVid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid>> 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
-
setCfiBit
public VlanVidBuilder setCfiBit(Boolean value)
Set the property corresponding toVlanVid.getCfiBit()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMask
public VlanVidBuilder setMask(byte[] value)
Set the property corresponding toVlanVid.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVlanVid
public VlanVidBuilder setVlanVid(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toVlanVid.getVlanVid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public VlanVidBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid> 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 VlanVidBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid>> 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
-
-