Class BgpvpnRouterAssociationsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.bgpvpn.router.association.rev190502.bgpvpn.router.associations.attributes.BgpvpnRouterAssociationsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpvpnRouterAssociations>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpvpnRouterAssociations,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BgpvpnRouterAssociationsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BgpvpnRouterAssociations>
Class that buildsBgpvpnRouterAssociationsBuilder
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:
BgpvpnRouterAssociationsBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpvpnRouterAssociationsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpvpnRouterAssociationsBuilder, 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:
BgpvpnRouterAssociationsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpvpnRouterAssociationsBuilder()
BgpvpnRouterAssociationsBuilder(BgpvpnRouterAssociations base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BgpvpnRouterAssociationsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BgpvpnRouterAssociationsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations>>
E$$augmentation(Class<E$$> augmentationType)
BgpvpnRouterAssociations
build()
Map<BgpvpnRouterAssociationKey,BgpvpnRouterAssociation>
getBgpvpnRouterAssociation()
BgpvpnRouterAssociationsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations>> augmentationType)
Remove an augmentation from this builder's product.BgpvpnRouterAssociationsBuilder
setBgpvpnRouterAssociation(List<BgpvpnRouterAssociation> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBgpvpnRouterAssociation(Map)
instead.BgpvpnRouterAssociationsBuilder
setBgpvpnRouterAssociation(Map<BgpvpnRouterAssociationKey,BgpvpnRouterAssociation> values)
-
-
-
Constructor Detail
-
BgpvpnRouterAssociationsBuilder
public BgpvpnRouterAssociationsBuilder()
-
BgpvpnRouterAssociationsBuilder
public BgpvpnRouterAssociationsBuilder(BgpvpnRouterAssociations base)
-
-
Method Detail
-
getBgpvpnRouterAssociation
public Map<BgpvpnRouterAssociationKey,BgpvpnRouterAssociation> getBgpvpnRouterAssociation()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations>> E$$ augmentation(Class<E$$> augmentationType)
-
setBgpvpnRouterAssociation
public BgpvpnRouterAssociationsBuilder setBgpvpnRouterAssociation(Map<BgpvpnRouterAssociationKey,BgpvpnRouterAssociation> values)
-
setBgpvpnRouterAssociation
@Deprecated(forRemoval=true) public BgpvpnRouterAssociationsBuilder setBgpvpnRouterAssociation(List<BgpvpnRouterAssociation> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBgpvpnRouterAssociation(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:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public BgpvpnRouterAssociationsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public BgpvpnRouterAssociationsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations> 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 BgpvpnRouterAssociationsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpvpnRouterAssociations>> 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 BgpvpnRouterAssociations build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BgpvpnRouterAssociations>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BgpvpnRouterAssociations,IllegalArgumentException>
-
-