Class L3vpnDcGwsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.L3vpnDcGwsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L3vpnDcGws>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnDcGws,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class L3vpnDcGwsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<L3vpnDcGws>
Class that buildsL3vpnDcGwsBuilder
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:
L3vpnDcGwsBuilder createTarget(int fooXyzzy, int barBaz) { return new L3vpnDcGwsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L3vpnDcGwsBuilder, 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:
L3vpnDcGwsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L3vpnDcGwsBuilder()
L3vpnDcGwsBuilder(L3vpnDcGws base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description L3vpnDcGwsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnDcGws> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnDcGws>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
L3vpnDcGws
build()
java.util.Map<DcGatewayKey,DcGateway>
getDcGateway()
L3vpnDcGwsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnDcGws>> augmentationType)
Remove an augmentation from this builder's product.L3vpnDcGwsBuilder
setDcGateway(java.util.List<DcGateway> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDcGateway(Map)
instead.L3vpnDcGwsBuilder
setDcGateway(java.util.Map<DcGatewayKey,DcGateway> values)
-
-
-
Constructor Detail
-
L3vpnDcGwsBuilder
public L3vpnDcGwsBuilder()
-
L3vpnDcGwsBuilder
public L3vpnDcGwsBuilder(L3vpnDcGws base)
-
-
Method Detail
-
getDcGateway
public java.util.Map<DcGatewayKey,DcGateway> getDcGateway()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnDcGws>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setDcGateway
public L3vpnDcGwsBuilder setDcGateway(java.util.Map<DcGatewayKey,DcGateway> values)
-
setDcGateway
@Deprecated(forRemoval=true) public L3vpnDcGwsBuilder setDcGateway(java.util.List<DcGateway> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDcGateway(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
addAugmentation
public L3vpnDcGwsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnDcGws> 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 L3vpnDcGwsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnDcGws>> 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 L3vpnDcGws build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<L3vpnDcGws>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnDcGws,java.lang.IllegalArgumentException>
-
-