Class VirtualNetworkIdentifierBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.VirtualNetworkIdentifierBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VirtualNetworkIdentifier>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VirtualNetworkIdentifier,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VirtualNetworkIdentifierBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VirtualNetworkIdentifier>
Class that buildsVirtualNetworkIdentifierBuilder
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:
VirtualNetworkIdentifierBuilder createTarget(int fooXyzzy, int barBaz) { return new VirtualNetworkIdentifierBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VirtualNetworkIdentifierBuilder, 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:
VirtualNetworkIdentifierBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VirtualNetworkIdentifierBuilder()
VirtualNetworkIdentifierBuilder(DbInstance arg)
VirtualNetworkIdentifierBuilder(VirtualNetworkIdentifier base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VirtualNetworkIdentifierBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VirtualNetworkIdentifier> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VirtualNetworkIdentifier>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VirtualNetworkIdentifier
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.util.Map<AuthenticationKeyKey,AuthenticationKey>
getAuthenticationKey()
java.util.Map<MappingKey,Mapping>
getMapping()
VniUri
getVni()
VirtualNetworkIdentifierKey
key()
VirtualNetworkIdentifierBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VirtualNetworkIdentifier>> augmentationType)
Remove an augmentation from this builder's product.VirtualNetworkIdentifierBuilder
setAuthenticationKey(java.util.List<AuthenticationKey> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAuthenticationKey(Map)
instead.VirtualNetworkIdentifierBuilder
setAuthenticationKey(java.util.Map<AuthenticationKeyKey,AuthenticationKey> values)
VirtualNetworkIdentifierBuilder
setMapping(java.util.List<Mapping> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMapping(Map)
instead.VirtualNetworkIdentifierBuilder
setMapping(java.util.Map<MappingKey,Mapping> values)
VirtualNetworkIdentifierBuilder
setVni(VniUri value)
VirtualNetworkIdentifierBuilder
withKey(VirtualNetworkIdentifierKey key)
-
-
-
Constructor Detail
-
VirtualNetworkIdentifierBuilder
public VirtualNetworkIdentifierBuilder()
-
VirtualNetworkIdentifierBuilder
public VirtualNetworkIdentifierBuilder(DbInstance arg)
-
VirtualNetworkIdentifierBuilder
public VirtualNetworkIdentifierBuilder(VirtualNetworkIdentifier base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.DbInstance
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public VirtualNetworkIdentifierKey key()
-
getAuthenticationKey
public java.util.Map<AuthenticationKeyKey,AuthenticationKey> getAuthenticationKey()
-
getMapping
public java.util.Map<MappingKey,Mapping> getMapping()
-
getVni
public VniUri getVni()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VirtualNetworkIdentifier>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VirtualNetworkIdentifierBuilder withKey(VirtualNetworkIdentifierKey key)
-
setAuthenticationKey
public VirtualNetworkIdentifierBuilder setAuthenticationKey(java.util.Map<AuthenticationKeyKey,AuthenticationKey> values)
-
setAuthenticationKey
@Deprecated(forRemoval=true) public VirtualNetworkIdentifierBuilder setAuthenticationKey(java.util.List<AuthenticationKey> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAuthenticationKey(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
-
setMapping
public VirtualNetworkIdentifierBuilder setMapping(java.util.Map<MappingKey,Mapping> values)
-
setMapping
@Deprecated(forRemoval=true) public VirtualNetworkIdentifierBuilder setMapping(java.util.List<Mapping> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMapping(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
-
setVni
public VirtualNetworkIdentifierBuilder setVni(VniUri value)
-
addAugmentation
public VirtualNetworkIdentifierBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VirtualNetworkIdentifier> 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 VirtualNetworkIdentifierBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VirtualNetworkIdentifier>> 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 VirtualNetworkIdentifier build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VirtualNetworkIdentifier>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VirtualNetworkIdentifier,java.lang.IllegalArgumentException>
-
-