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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VlanVid>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VlanVid,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VlanVidBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<VlanVid>
Class that buildsVlanVidBuilder
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:
VlanVidBuilder createTarget(int fooXyzzy, int barBaz) { return new VlanVidBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VlanVidBuilder, 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:
VlanVidBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VlanVidBuilder()
VlanVidBuilder(VlanVid base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
VlanVid
build()
Boolean
getCfiBit()
byte[]
getMask()
org.opendaylight.yangtools.yang.common.Uint16
getVlanVid()
Boolean
isCfiBit()
Deprecated, for removal: This API element is subject to removal in a future version.VlanVidBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid>> augmentationType)
Remove an augmentation from this builder's product.VlanVidBuilder
setCfiBit(Boolean value)
VlanVidBuilder
setMask(byte[] value)
VlanVidBuilder
setVlanVid(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVlanVid(Uint16)
instead.VlanVidBuilder
setVlanVid(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
VlanVidBuilder
public VlanVidBuilder()
-
VlanVidBuilder
public VlanVidBuilder(VlanVid base)
-
-
Method Detail
-
getCfiBit
public Boolean getCfiBit()
-
isCfiBit
@Deprecated(forRemoval=true) public final Boolean isCfiBit()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getMask
public byte[] getMask()
-
getVlanVid
public org.opendaylight.yangtools.yang.common.Uint16 getVlanVid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanVid>> E$$ augmentation(Class<E$$> augmentationType)
-
setCfiBit
public VlanVidBuilder setCfiBit(Boolean value)
-
setMask
public VlanVidBuilder setMask(byte[] value)
-
setVlanVid
public VlanVidBuilder setVlanVid(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setVlanVid
@Deprecated(forRemoval=true) public VlanVidBuilder setVlanVid(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVlanVid(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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
-
build
public VlanVid build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VlanVid>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VlanVid,IllegalArgumentException>
-
-