Class MappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.MappingBuilder
-
@Generated("mdsal-binding-generator") public class MappingBuilder extends java.lang.Object
Class that buildsMapping
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:
Mapping createMapping(int fooXyzzy, int barBaz) { return new MappingBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Mapping, 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:
Mapping
- 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 MappingBuilder()
Construct an empty builder.MappingBuilder(MappingRecordContainer arg)
Construct a new builder initialized from specifiedMappingRecordContainer
.MappingBuilder(Mapping base)
Construct a builder initialized with state from specifiedMapping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MappingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Mapping> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Mapping
build()
A newMapping
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EidUri
getEidUri()
Return current value associated with the property corresponding toMapping.getEidUri()
.MappingRecord
getMappingRecord()
Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.MappingOrigin
getOrigin()
Return current value associated with the property corresponding toMapping.getOrigin()
.java.util.Set<SiteId>
getSiteId()
Return current value associated with the property corresponding toMapping.getSiteId()
.java.util.Map<XtrIdMappingKey,XtrIdMapping>
getXtrIdMapping()
Return current value associated with the property corresponding toMapping.getXtrIdMapping()
.MappingKey
key()
Return current value associated with the property corresponding toMapping.key()
.MappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> augmentationType)
Remove an augmentation from this builder's product.MappingBuilder
setEidUri(EidUri value)
Set the property corresponding toMapping.getEidUri()
to the specified value.MappingBuilder
setMappingRecord(MappingRecord value)
Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.MappingBuilder
setOrigin(MappingOrigin value)
Set the property corresponding toMapping.getOrigin()
to the specified value.MappingBuilder
setSiteId(java.util.Set<SiteId> values)
Set the property corresponding toMapping.getSiteId()
to the specified value.MappingBuilder
setXtrIdMapping(java.util.Map<XtrIdMappingKey,XtrIdMapping> values)
Set the property corresponding toMapping.getXtrIdMapping()
to the specified value.MappingBuilder
withKey(MappingKey key)
-
-
-
Constructor Detail
-
MappingBuilder
public MappingBuilder()
Construct an empty builder.
-
MappingBuilder
public MappingBuilder(MappingRecordContainer arg)
Construct a new builder initialized from specifiedMappingRecordContainer
.- Parameters:
arg
- MappingRecordContainer from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public MappingKey key()
Return current value associated with the property corresponding toMapping.key()
.- Returns:
- current value
-
getEidUri
public EidUri getEidUri()
Return current value associated with the property corresponding toMapping.getEidUri()
.- Returns:
- current value
-
getMappingRecord
public MappingRecord getMappingRecord()
Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.- Returns:
- current value
-
getOrigin
public MappingOrigin getOrigin()
Return current value associated with the property corresponding toMapping.getOrigin()
.- Returns:
- current value
-
getSiteId
public java.util.Set<SiteId> getSiteId()
Return current value associated with the property corresponding toMapping.getSiteId()
.- Returns:
- current value
-
getXtrIdMapping
public java.util.Map<XtrIdMappingKey,XtrIdMapping> getXtrIdMapping()
Return current value associated with the property corresponding toMapping.getXtrIdMapping()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> 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
-
withKey
public MappingBuilder withKey(MappingKey key)
-
setEidUri
public MappingBuilder setEidUri(EidUri value)
Set the property corresponding toMapping.getEidUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappingRecord
public MappingBuilder setMappingRecord(MappingRecord value)
Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOrigin
public MappingBuilder setOrigin(MappingOrigin value)
Set the property corresponding toMapping.getOrigin()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSiteId
public MappingBuilder setSiteId(java.util.Set<SiteId> values)
Set the property corresponding toMapping.getSiteId()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setXtrIdMapping
public MappingBuilder setXtrIdMapping(java.util.Map<XtrIdMappingKey,XtrIdMapping> values)
Set the property corresponding toMapping.getXtrIdMapping()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public MappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Mapping> 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 MappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> 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
-
-