Class PushVlanActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.push.vlan.action._case.PushVlanActionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PushVlanAction>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PushVlanAction,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PushVlanActionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PushVlanAction>
Class that buildsPushVlanActionBuilder
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:
PushVlanActionBuilder createTarget(int fooXyzzy, int barBaz) { return new PushVlanActionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PushVlanActionBuilder, 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:
PushVlanActionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PushVlanActionBuilder()
PushVlanActionBuilder(PushVlanAction base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PushVlanActionBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction>>
E$$augmentation(Class<E$$> augmentationType)
PushVlanAction
build()
VlanCfi
getCfi()
org.opendaylight.yangtools.yang.common.Uint16
getEthernetType()
Integer
getPcp()
Integer
getTag()
org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
getVlanId()
PushVlanActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction>> augmentationType)
PushVlanActionBuilder
setCfi(VlanCfi value)
PushVlanActionBuilder
setEthernetType(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setEthernetType(Uint16)} instead.PushVlanActionBuilder
setEthernetType(org.opendaylight.yangtools.yang.common.Uint16 value)
PushVlanActionBuilder
setPcp(Integer value)
PushVlanActionBuilder
setTag(Integer value)
PushVlanActionBuilder
setVlanId(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
-
-
-
Constructor Detail
-
PushVlanActionBuilder
public PushVlanActionBuilder()
-
PushVlanActionBuilder
public PushVlanActionBuilder(PushVlanAction base)
-
-
Method Detail
-
getCfi
public VlanCfi getCfi()
-
getEthernetType
public org.opendaylight.yangtools.yang.common.Uint16 getEthernetType()
-
getPcp
public Integer getPcp()
-
getTag
public Integer getTag()
-
getVlanId
public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction>> E$$ augmentation(Class<E$$> augmentationType)
-
setCfi
public PushVlanActionBuilder setCfi(VlanCfi value)
-
setEthernetType
public PushVlanActionBuilder setEthernetType(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setEthernetType
@Deprecated(forRemoval=true) public PushVlanActionBuilder setEthernetType(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setEthernetType(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPcp
public PushVlanActionBuilder setPcp(Integer value)
-
setTag
public PushVlanActionBuilder setTag(Integer value)
-
setVlanId
public PushVlanActionBuilder setVlanId(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
-
addAugmentation
public PushVlanActionBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction> augmentationValue)
-
removeAugmentation
public PushVlanActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PushVlanAction>> augmentationType)
-
build
public PushVlanAction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PushVlanAction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PushVlanAction,IllegalArgumentException>
-
-