Class EvpnRdToNetworkBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.evpn.rd.to.networks.EvpnRdToNetworkBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EvpnRdToNetwork>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EvpnRdToNetwork,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class EvpnRdToNetworkBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<EvpnRdToNetwork>
Class that buildsEvpnRdToNetworkBuilder
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:
EvpnRdToNetworkBuilder createTarget(int fooXyzzy, int barBaz) { return new EvpnRdToNetworkBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EvpnRdToNetworkBuilder, 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:
EvpnRdToNetworkBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EvpnRdToNetworkBuilder()
EvpnRdToNetworkBuilder(EvpnRdToNetwork base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description EvpnRdToNetworkBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.EvpnRdToNetworkBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
EvpnRdToNetwork
build()
java.lang.String
getNetworkId()
java.lang.String
getRd()
EvpnRdToNetworkKey
key()
EvpnRdToNetworkBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork>> augmentationType)
Remove an augmentation from this builder's product.EvpnRdToNetworkBuilder
setNetworkId(java.lang.String value)
EvpnRdToNetworkBuilder
setRd(java.lang.String value)
EvpnRdToNetworkBuilder
withKey(EvpnRdToNetworkKey key)
-
-
-
Constructor Detail
-
EvpnRdToNetworkBuilder
public EvpnRdToNetworkBuilder()
-
EvpnRdToNetworkBuilder
public EvpnRdToNetworkBuilder(EvpnRdToNetwork base)
-
-
Method Detail
-
key
public EvpnRdToNetworkKey key()
-
getNetworkId
public java.lang.String getNetworkId()
-
getRd
public java.lang.String getRd()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public EvpnRdToNetworkBuilder withKey(EvpnRdToNetworkKey key)
-
setNetworkId
public EvpnRdToNetworkBuilder setNetworkId(java.lang.String value)
-
setRd
public EvpnRdToNetworkBuilder setRd(java.lang.String value)
-
addAugmentation
public EvpnRdToNetworkBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork> 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
-
addAugmentation
@Deprecated(forRemoval=true) public EvpnRdToNetworkBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public EvpnRdToNetworkBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRdToNetwork>> 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 EvpnRdToNetwork build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EvpnRdToNetwork>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EvpnRdToNetwork,java.lang.IllegalArgumentException>
-
-