Class VlanPcpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.vlan.pcp._case.VlanPcpBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VlanPcp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VlanPcp,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VlanPcpBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<VlanPcp>
Class that buildsVlanPcpBuilder
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:
VlanPcpBuilder createTarget(int fooXyzzy, int barBaz) { return new VlanPcpBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VlanPcpBuilder, 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:
VlanPcpBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VlanPcpBuilder()
VlanPcpBuilder(VlanPcp base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VlanPcpBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp>>
E$$augmentation(Class<E$$> augmentationType)
VlanPcp
build()
org.opendaylight.yangtools.yang.common.Uint8
getVlanPcp()
VlanPcpBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp>> augmentationType)
VlanPcpBuilder
setVlanPcp(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVlanPcp(Uint8)} instead.VlanPcpBuilder
setVlanPcp(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
VlanPcpBuilder
public VlanPcpBuilder()
-
VlanPcpBuilder
public VlanPcpBuilder(VlanPcp base)
-
-
Method Detail
-
getVlanPcp
public org.opendaylight.yangtools.yang.common.Uint8 getVlanPcp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp>> E$$ augmentation(Class<E$$> augmentationType)
-
setVlanPcp
public VlanPcpBuilder setVlanPcp(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVlanPcp
@Deprecated(forRemoval=true) public VlanPcpBuilder setVlanPcp(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVlanPcp(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public VlanPcpBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp> augmentationValue)
-
removeAugmentation
public VlanPcpBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanPcp>> augmentationType)
-
build
public VlanPcp build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VlanPcp>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VlanPcp,IllegalArgumentException>
-
-