Class SetVlanCfiActionBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.vlan.cfi.action._case.SetVlanCfiActionBuilder
Class that builds
SetVlanCfiAction
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:
SetVlanCfiAction createSetVlanCfiAction(int fooXyzzy, int barBaz) {
return new SetVlanCfiActionBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SetVlanCfiAction, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedSetVlanCfiAction
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanCfiAction> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanCfiAction>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SetVlanCfiAction
build()
A newSetVlanCfiAction
instance.Return current value associated with the property corresponding toSetVlanCfiAction.getVlanCfi()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanCfiAction>> augmentationType) Remove an augmentation from this builder's product.setVlanCfi
(VlanCfi value) Set the property corresponding toSetVlanCfiAction.getVlanCfi()
to the specified value.
-
Constructor Details
-
SetVlanCfiActionBuilder
public SetVlanCfiActionBuilder()Construct an empty builder. -
SetVlanCfiActionBuilder
Construct a builder initialized with state from specifiedSetVlanCfiAction
.- Parameters:
base
- SetVlanCfiAction from which the builder should be initialized
-
-
Method Details
-
getVlanCfi
Return current value associated with the property corresponding toSetVlanCfiAction.getVlanCfi()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanCfiAction>> 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
-
setVlanCfi
Set the property corresponding toSetVlanCfiAction.getVlanCfi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetVlanCfiActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanCfiAction> 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 SetVlanCfiActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanCfiAction>> 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
A newSetVlanCfiAction
instance.- Returns:
- A new
SetVlanCfiAction
instance.
-