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