Class AssociatedVpnBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AssociatedVpn>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AssociatedVpn,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AssociatedVpnBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AssociatedVpn>
Class that buildsAssociatedVpnBuilder
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:
AssociatedVpnBuilder createTarget(int fooXyzzy, int barBaz) { return new AssociatedVpnBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AssociatedVpnBuilder, 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:
AssociatedVpnBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AssociatedVpnBuilder()
AssociatedVpnBuilder(AssociatedVpn base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssociatedVpnBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AssociatedVpn> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociatedVpn>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AssociatedVpn
build()
java.lang.String
getName()
AssociatedVpnKey
key()
AssociatedVpnBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociatedVpn>> augmentationType)
Remove an augmentation from this builder's product.AssociatedVpnBuilder
setName(java.lang.String value)
AssociatedVpnBuilder
withKey(AssociatedVpnKey key)
-
-
-
Constructor Detail
-
AssociatedVpnBuilder
public AssociatedVpnBuilder()
-
AssociatedVpnBuilder
public AssociatedVpnBuilder(AssociatedVpn base)
-
-
Method Detail
-
key
public AssociatedVpnKey key()
-
getName
public java.lang.String getName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociatedVpn>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public AssociatedVpnBuilder withKey(AssociatedVpnKey key)
-
setName
public AssociatedVpnBuilder setName(java.lang.String value)
-
addAugmentation
public AssociatedVpnBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AssociatedVpn> 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 AssociatedVpnBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociatedVpn>> 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 AssociatedVpn build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AssociatedVpn>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AssociatedVpn,java.lang.IllegalArgumentException>
-
-