Class SetVlanIdActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.vlan.id.action._case.SetVlanIdActionBuilder
-
@Generated("mdsal-binding-generator") public class SetVlanIdActionBuilder extends Object
Class that buildsSetVlanIdAction
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:
SetVlanIdAction createSetVlanIdAction(int fooXyzzy, int barBaz) { return new SetVlanIdActionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetVlanIdAction, 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:
SetVlanIdAction
- 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 SetVlanIdActionBuilder()
Construct an empty builder.SetVlanIdActionBuilder(SetVlanIdAction base)
Construct a builder initialized with state from specifiedSetVlanIdAction
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetVlanIdActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanIdAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanIdAction>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SetVlanIdAction
build()
A newSetVlanIdAction
instance.org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
getVlanId()
Return current value associated with the property corresponding toSetVlanIdAction.getVlanId()
.SetVlanIdActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanIdAction>> augmentationType)
Remove an augmentation from this builder's product.SetVlanIdActionBuilder
setVlanId(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
Set the property corresponding toSetVlanIdAction.getVlanId()
to the specified value.
-
-
-
Constructor Detail
-
SetVlanIdActionBuilder
public SetVlanIdActionBuilder()
Construct an empty builder.
-
SetVlanIdActionBuilder
public SetVlanIdActionBuilder(SetVlanIdAction base)
Construct a builder initialized with state from specifiedSetVlanIdAction
.- Parameters:
base
- SetVlanIdAction from which the builder should be initialized
-
-
Method Detail
-
getVlanId
public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanId()
Return current value associated with the property corresponding toSetVlanIdAction.getVlanId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanIdAction>> 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
-
setVlanId
public SetVlanIdActionBuilder setVlanId(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
Set the property corresponding toSetVlanIdAction.getVlanId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetVlanIdActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanIdAction> 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 SetVlanIdActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanIdAction>> 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 SetVlanIdAction build()
A newSetVlanIdAction
instance.- Returns:
- A new
SetVlanIdAction
instance.
-
-