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