Class VpnTargetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance.vpntargets.VpnTargetBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnTarget>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnTarget,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnTargetBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnTarget>
Class that buildsVpnTargetBuilder
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:
VpnTargetBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnTargetBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnTargetBuilder, 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:
VpnTargetBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnTargetBuilder()
VpnTargetBuilder(VpnTarget base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnTargetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnTarget> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnTarget>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnTarget
build()
VpnTarget.VrfRTType
getVrfRTType()
java.lang.String
getVrfRTValue()
VpnTargetKey
key()
VpnTargetBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnTarget>> augmentationType)
Remove an augmentation from this builder's product.VpnTargetBuilder
setVrfRTType(VpnTarget.VrfRTType value)
VpnTargetBuilder
setVrfRTValue(java.lang.String value)
VpnTargetBuilder
withKey(VpnTargetKey key)
-
-
-
Constructor Detail
-
VpnTargetBuilder
public VpnTargetBuilder()
-
VpnTargetBuilder
public VpnTargetBuilder(VpnTarget base)
-
-
Method Detail
-
key
public VpnTargetKey key()
-
getVrfRTType
public VpnTarget.VrfRTType getVrfRTType()
-
getVrfRTValue
public java.lang.String getVrfRTValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnTarget>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnTargetBuilder withKey(VpnTargetKey key)
-
setVrfRTType
public VpnTargetBuilder setVrfRTType(VpnTarget.VrfRTType value)
-
setVrfRTValue
public VpnTargetBuilder setVrfRTValue(java.lang.String value)
-
addAugmentation
public VpnTargetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnTarget> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public VpnTargetBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnTarget>> 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
-
-