Class MappingDatabaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingDatabaseBuilder
-
@Generated("mdsal-binding-generator") public class MappingDatabaseBuilder extends java.lang.Object
Class that buildsMappingDatabase
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:
MappingDatabase createMappingDatabase(int fooXyzzy, int barBaz) { return new MappingDatabaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MappingDatabase, 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 opportunities, 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:
MappingDatabase
- 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
-
-
Constructor Summary
Constructors Constructor Description MappingDatabaseBuilder()
Construct an empty builder.MappingDatabaseBuilder(MappingDatabase base)
Construct a builder initialized with state from specifiedMappingDatabase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MappingDatabaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MappingDatabase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingDatabase>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MappingDatabase
build()
A newMappingDatabase
instance.LastUpdated
getLastUpdated()
Return current value associated with the property corresponding toMappingDatabase.getLastUpdated()
.java.util.Map<VirtualNetworkIdentifierKey,VirtualNetworkIdentifier>
getVirtualNetworkIdentifier()
Return current value associated with the property corresponding toMappingDatabase.getVirtualNetworkIdentifier()
.MappingDatabaseBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingDatabase>> augmentationType)
Remove an augmentation from this builder's product.MappingDatabaseBuilder
setLastUpdated(LastUpdated value)
Set the property corresponding toMappingDatabase.getLastUpdated()
to the specified value.MappingDatabaseBuilder
setVirtualNetworkIdentifier(java.util.Map<VirtualNetworkIdentifierKey,VirtualNetworkIdentifier> values)
Set the property corresponding toMappingDatabase.getVirtualNetworkIdentifier()
to the specified value.
-
-
-
Constructor Detail
-
MappingDatabaseBuilder
public MappingDatabaseBuilder()
Construct an empty builder.
-
MappingDatabaseBuilder
public MappingDatabaseBuilder(MappingDatabase base)
Construct a builder initialized with state from specifiedMappingDatabase
.- Parameters:
base
- MappingDatabase from which the builder should be initialized
-
-
Method Detail
-
getLastUpdated
public LastUpdated getLastUpdated()
Return current value associated with the property corresponding toMappingDatabase.getLastUpdated()
.- Returns:
- current value
-
getVirtualNetworkIdentifier
public java.util.Map<VirtualNetworkIdentifierKey,VirtualNetworkIdentifier> getVirtualNetworkIdentifier()
Return current value associated with the property corresponding toMappingDatabase.getVirtualNetworkIdentifier()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingDatabase>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setLastUpdated
public MappingDatabaseBuilder setLastUpdated(LastUpdated value)
Set the property corresponding toMappingDatabase.getLastUpdated()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVirtualNetworkIdentifier
public MappingDatabaseBuilder setVirtualNetworkIdentifier(java.util.Map<VirtualNetworkIdentifierKey,VirtualNetworkIdentifier> values)
Set the property corresponding toMappingDatabase.getVirtualNetworkIdentifier()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public MappingDatabaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MappingDatabase> 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 MappingDatabaseBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingDatabase>> 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 @NonNull MappingDatabase build()
A newMappingDatabase
instance.- Returns:
- A new
MappingDatabase
instance.
-
-