Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.mapping
Class XtrIdMappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.mapping.XtrIdMappingBuilder
-
@Generated("mdsal-binding-generator") public class XtrIdMappingBuilder extends java.lang.Object
Class that buildsXtrIdMapping
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:
XtrIdMapping createXtrIdMapping(int fooXyzzy, int barBaz) { return new XtrIdMappingBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of XtrIdMapping, 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:
XtrIdMapping
- 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 XtrIdMappingBuilder()
Construct an empty builder.XtrIdMappingBuilder(MappingRecordContainer arg)
Construct a new builder initialized from specifiedMappingRecordContainer
.XtrIdMappingBuilder(XtrIdMapping base)
Construct a builder initialized with state from specifiedXtrIdMapping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XtrIdMappingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<XtrIdMapping> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrIdMapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull XtrIdMapping
build()
A newXtrIdMapping
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MappingRecord
getMappingRecord()
Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.XtrIdUri
getXtrIdUri()
Return current value associated with the property corresponding toXtrIdMapping.getXtrIdUri()
.XtrIdMappingKey
key()
Return current value associated with the property corresponding toXtrIdMapping.key()
.XtrIdMappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrIdMapping>> augmentationType)
Remove an augmentation from this builder's product.XtrIdMappingBuilder
setMappingRecord(MappingRecord value)
Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.XtrIdMappingBuilder
setXtrIdUri(XtrIdUri value)
Set the property corresponding toXtrIdMapping.getXtrIdUri()
to the specified value.XtrIdMappingBuilder
withKey(XtrIdMappingKey key)
-
-
-
Constructor Detail
-
XtrIdMappingBuilder
public XtrIdMappingBuilder()
Construct an empty builder.
-
XtrIdMappingBuilder
public XtrIdMappingBuilder(MappingRecordContainer arg)
Construct a new builder initialized from specifiedMappingRecordContainer
.- Parameters:
arg
- MappingRecordContainer from which the builder should be initialized
-
XtrIdMappingBuilder
public XtrIdMappingBuilder(XtrIdMapping base)
Construct a builder initialized with state from specifiedXtrIdMapping
.- Parameters:
base
- XtrIdMapping 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 XtrIdMappingKey key()
Return current value associated with the property corresponding toXtrIdMapping.key()
.- Returns:
- current value
-
getMappingRecord
public MappingRecord getMappingRecord()
Return current value associated with the property corresponding toMappingRecordContainer.getMappingRecord()
.- Returns:
- current value
-
getXtrIdUri
public XtrIdUri getXtrIdUri()
Return current value associated with the property corresponding toXtrIdMapping.getXtrIdUri()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrIdMapping>> 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 XtrIdMappingBuilder withKey(XtrIdMappingKey key)
-
setMappingRecord
public XtrIdMappingBuilder setMappingRecord(MappingRecord value)
Set the property corresponding toMappingRecordContainer.getMappingRecord()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXtrIdUri
public XtrIdMappingBuilder setXtrIdUri(XtrIdUri value)
Set the property corresponding toXtrIdMapping.getXtrIdUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public XtrIdMappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<XtrIdMapping> 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 XtrIdMappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<XtrIdMapping>> 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 XtrIdMapping build()
A newXtrIdMapping
instance.- Returns:
- A new
XtrIdMapping
instance.
-
-