Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.container
Class MappingRecordBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.container.MappingRecordBuilder
Class that builds
MappingRecord
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:
MappingRecord createMappingRecord(int fooXyzzy, int barBaz) {
return new MappingRecordBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MappingRecord, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedEidContainer
.Construct a new builder initialized from specifiedLocatorRecords
.Construct a builder initialized with state from specifiedMappingRecord
.Construct a new builder initialized from specifiedMappingRecordMetadata
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MappingRecord
build()
A newMappingRecord
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMappingRecord.getAction()
.Return current value associated with the property corresponding toMappingRecord.getAuthoritative()
.getEid()
Return current value associated with the property corresponding toEidContainer.getEid()
.Return current value associated with the property corresponding toLocatorRecords.getLocatorRecord()
.Return current value associated with the property corresponding toMappingRecord.getMapVersion()
.Return current value associated with the property corresponding toMappingRecord.getRecordTtl()
.Return current value associated with the property corresponding toMappingRecordMetadata.getSiteId()
.Return current value associated with the property corresponding toMappingRecordMetadata.getSourceRloc()
.Return current value associated with the property corresponding toMappingRecordMetadata.getTimestamp()
.getXtrId()
Return current value associated with the property corresponding toMappingRecordMetadata.getXtrId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord>> augmentationType) Remove an augmentation from this builder's product.setAction
(MappingRecord.Action value) Set the property corresponding toMappingRecord.getAction()
to the specified value.setAuthoritative
(Boolean value) Set the property corresponding toMappingRecord.getAuthoritative()
to the specified value.Set the property corresponding toEidContainer.getEid()
to the specified value.setLocatorRecord
(List<LocatorRecord> values) Set the property corresponding toLocatorRecords.getLocatorRecord()
to the specified value.setMapVersion
(Short value) Set the property corresponding toMappingRecord.getMapVersion()
to the specified value.setRecordTtl
(Integer value) Set the property corresponding toMappingRecord.getRecordTtl()
to the specified value.Set the property corresponding toMappingRecordMetadata.getSiteId()
to the specified value.setSourceRloc
(IpAddressBinary value) Set the property corresponding toMappingRecordMetadata.getSourceRloc()
to the specified value.setTimestamp
(Long value) Set the property corresponding toMappingRecordMetadata.getTimestamp()
to the specified value.Set the property corresponding toMappingRecordMetadata.getXtrId()
to the specified value.
-
Constructor Details
-
MappingRecordBuilder
public MappingRecordBuilder()Construct an empty builder. -
MappingRecordBuilder
Construct a new builder initialized from specifiedEidContainer
.- Parameters:
arg
- EidContainer from which the builder should be initialized
-
MappingRecordBuilder
Construct a new builder initialized from specifiedLocatorRecords
.- Parameters:
arg
- LocatorRecords from which the builder should be initialized
-
MappingRecordBuilder
Construct a new builder initialized from specifiedMappingRecordMetadata
.- Parameters:
arg
- MappingRecordMetadata from which the builder should be initialized
-
MappingRecordBuilder
Construct a builder initialized with state from specifiedMappingRecord
.- Parameters:
base
- MappingRecord from which the builder should be initialized
-
-
Method Details
-
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:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAction
Return current value associated with the property corresponding toMappingRecord.getAction()
.- Returns:
- current value
-
getAuthoritative
Return current value associated with the property corresponding toMappingRecord.getAuthoritative()
.- Returns:
- current value
-
getEid
Return current value associated with the property corresponding toEidContainer.getEid()
.- Returns:
- current value
-
getLocatorRecord
Return current value associated with the property corresponding toLocatorRecords.getLocatorRecord()
.- Returns:
- current value
-
getMapVersion
Return current value associated with the property corresponding toMappingRecord.getMapVersion()
.- Returns:
- current value
-
getRecordTtl
Return current value associated with the property corresponding toMappingRecord.getRecordTtl()
.- Returns:
- current value
-
getSiteId
Return current value associated with the property corresponding toMappingRecordMetadata.getSiteId()
.- Returns:
- current value
-
getSourceRloc
Return current value associated with the property corresponding toMappingRecordMetadata.getSourceRloc()
.- Returns:
- current value
-
getTimestamp
Return current value associated with the property corresponding toMappingRecordMetadata.getTimestamp()
.- Returns:
- current value
-
getXtrId
Return current value associated with the property corresponding toMappingRecordMetadata.getXtrId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord>> E$$ augmentation(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:
NullPointerException
- ifaugmentType
isnull
-
setAction
Set the property corresponding toMappingRecord.getAction()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAuthoritative
Set the property corresponding toMappingRecord.getAuthoritative()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEid
Set the property corresponding toEidContainer.getEid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocatorRecord
Set the property corresponding toLocatorRecords.getLocatorRecord()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMapVersion
Set the property corresponding toMappingRecord.getMapVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRecordTtl
Set the property corresponding toMappingRecord.getRecordTtl()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSiteId
Set the property corresponding toMappingRecordMetadata.getSiteId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSourceRloc
Set the property corresponding toMappingRecordMetadata.getSourceRloc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTimestamp
Set the property corresponding toMappingRecordMetadata.getTimestamp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXtrId
Set the property corresponding toMappingRecordMetadata.getXtrId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MappingRecordBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MappingRecordBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord>> 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
A newMappingRecord
instance.- Returns:
- A new
MappingRecord
instance.
-