Class SetVlanPcpActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.set.vlan.pcp._case.SetVlanPcpActionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SetVlanPcpAction>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SetVlanPcpAction,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SetVlanPcpActionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SetVlanPcpAction>
Class that buildsSetVlanPcpActionBuilder
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:
SetVlanPcpActionBuilder createTarget(int fooXyzzy, int barBaz) { return new SetVlanPcpActionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetVlanPcpActionBuilder, 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:
SetVlanPcpActionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SetVlanPcpActionBuilder()
SetVlanPcpActionBuilder(SetVlanPcpAction base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SetVlanPcpActionBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanPcpAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanPcpAction> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
SetVlanPcpAction
build()
org.opendaylight.yangtools.yang.common.Uint8
getVlanPcp()
SetVlanPcpActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanPcpAction>> augmentationType)
Remove an augmentation from this builder's product.SetVlanPcpActionBuilder
setVlanPcp(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVlanPcp(Uint8)
instead.SetVlanPcpActionBuilder
setVlanPcp(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
SetVlanPcpActionBuilder
public SetVlanPcpActionBuilder()
-
SetVlanPcpActionBuilder
public SetVlanPcpActionBuilder(SetVlanPcpAction base)
-
-
Method Detail
-
getVlanPcp
public org.opendaylight.yangtools.yang.common.Uint8 getVlanPcp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanPcpAction>> E$$ augmentation(Class<E$$> augmentationType)
-
setVlanPcp
public SetVlanPcpActionBuilder setVlanPcp(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVlanPcp
@Deprecated(forRemoval=true) public SetVlanPcpActionBuilder setVlanPcp(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVlanPcp(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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
-
addAugmentation
@Deprecated(forRemoval=true) public SetVlanPcpActionBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanPcpAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SetVlanPcpAction> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 SetVlanPcpAction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SetVlanPcpAction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SetVlanPcpAction,IllegalArgumentException>
-
-