Class LocatorRecordBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder
-
@Generated("mdsal-binding-generator") public class LocatorRecordBuilder extends java.lang.Object
Class that buildsLocatorRecord
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:
LocatorRecord createLocatorRecord(int fooXyzzy, int barBaz) { return new LocatorRecordBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LocatorRecord, 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:
LocatorRecord
- 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 LocatorRecordBuilder()
Construct an empty builder.LocatorRecordBuilder(LocatorRecord base)
Construct a builder initialized with state from specifiedLocatorRecord
.LocatorRecordBuilder(RlocContainer arg)
Construct a new builder initialized from specifiedRlocContainer
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LocatorRecordBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocatorRecord> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorRecord>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LocatorRecord
build()
A newLocatorRecord
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.Boolean
getLocalLocator()
Return current value associated with the property corresponding toLocatorRecord.getLocalLocator()
.java.lang.String
getLocatorId()
Return current value associated with the property corresponding toLocatorRecord.getLocatorId()
.org.opendaylight.yangtools.yang.common.Uint8
getMulticastPriority()
Return current value associated with the property corresponding toLocatorRecord.getMulticastPriority()
.org.opendaylight.yangtools.yang.common.Uint8
getMulticastWeight()
Return current value associated with the property corresponding toLocatorRecord.getMulticastWeight()
.org.opendaylight.yangtools.yang.common.Uint8
getPriority()
Return current value associated with the property corresponding toLocatorRecord.getPriority()
.Rloc
getRloc()
Return current value associated with the property corresponding toRlocContainer.getRloc()
.java.lang.Boolean
getRlocProbed()
Return current value associated with the property corresponding toLocatorRecord.getRlocProbed()
.java.lang.Boolean
getRouted()
Return current value associated with the property corresponding toLocatorRecord.getRouted()
.org.opendaylight.yangtools.yang.common.Uint8
getWeight()
Return current value associated with the property corresponding toLocatorRecord.getWeight()
.LocatorRecordKey
key()
Return current value associated with the property corresponding toLocatorRecord.key()
.LocatorRecordBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorRecord>> augmentationType)
Remove an augmentation from this builder's product.LocatorRecordBuilder
setLocalLocator(java.lang.Boolean value)
Set the property corresponding toLocatorRecord.getLocalLocator()
to the specified value.LocatorRecordBuilder
setLocatorId(java.lang.String value)
Set the property corresponding toLocatorRecord.getLocatorId()
to the specified value.LocatorRecordBuilder
setMulticastPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getMulticastPriority()
to the specified value.LocatorRecordBuilder
setMulticastWeight(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getMulticastWeight()
to the specified value.LocatorRecordBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getPriority()
to the specified value.LocatorRecordBuilder
setRloc(Rloc value)
Set the property corresponding toRlocContainer.getRloc()
to the specified value.LocatorRecordBuilder
setRlocProbed(java.lang.Boolean value)
Set the property corresponding toLocatorRecord.getRlocProbed()
to the specified value.LocatorRecordBuilder
setRouted(java.lang.Boolean value)
Set the property corresponding toLocatorRecord.getRouted()
to the specified value.LocatorRecordBuilder
setWeight(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getWeight()
to the specified value.LocatorRecordBuilder
withKey(LocatorRecordKey key)
-
-
-
Constructor Detail
-
LocatorRecordBuilder
public LocatorRecordBuilder()
Construct an empty builder.
-
LocatorRecordBuilder
public LocatorRecordBuilder(RlocContainer arg)
Construct a new builder initialized from specifiedRlocContainer
.- Parameters:
arg
- RlocContainer from which the builder should be initialized
-
LocatorRecordBuilder
public LocatorRecordBuilder(LocatorRecord base)
Construct a builder initialized with state from specifiedLocatorRecord
.- Parameters:
base
- LocatorRecord 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 LocatorRecordKey key()
Return current value associated with the property corresponding toLocatorRecord.key()
.- Returns:
- current value
-
getLocalLocator
public java.lang.Boolean getLocalLocator()
Return current value associated with the property corresponding toLocatorRecord.getLocalLocator()
.- Returns:
- current value
-
getLocatorId
public java.lang.String getLocatorId()
Return current value associated with the property corresponding toLocatorRecord.getLocatorId()
.- Returns:
- current value
-
getMulticastPriority
public org.opendaylight.yangtools.yang.common.Uint8 getMulticastPriority()
Return current value associated with the property corresponding toLocatorRecord.getMulticastPriority()
.- Returns:
- current value
-
getMulticastWeight
public org.opendaylight.yangtools.yang.common.Uint8 getMulticastWeight()
Return current value associated with the property corresponding toLocatorRecord.getMulticastWeight()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint8 getPriority()
Return current value associated with the property corresponding toLocatorRecord.getPriority()
.- Returns:
- current value
-
getRloc
public Rloc getRloc()
Return current value associated with the property corresponding toRlocContainer.getRloc()
.- Returns:
- current value
-
getRlocProbed
public java.lang.Boolean getRlocProbed()
Return current value associated with the property corresponding toLocatorRecord.getRlocProbed()
.- Returns:
- current value
-
getRouted
public java.lang.Boolean getRouted()
Return current value associated with the property corresponding toLocatorRecord.getRouted()
.- Returns:
- current value
-
getWeight
public org.opendaylight.yangtools.yang.common.Uint8 getWeight()
Return current value associated with the property corresponding toLocatorRecord.getWeight()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorRecord>> 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 LocatorRecordBuilder withKey(LocatorRecordKey key)
-
setLocalLocator
public LocatorRecordBuilder setLocalLocator(java.lang.Boolean value)
Set the property corresponding toLocatorRecord.getLocalLocator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocatorId
public LocatorRecordBuilder setLocatorId(java.lang.String value)
Set the property corresponding toLocatorRecord.getLocatorId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMulticastPriority
public LocatorRecordBuilder setMulticastPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getMulticastPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMulticastWeight
public LocatorRecordBuilder setMulticastWeight(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getMulticastWeight()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
public LocatorRecordBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRloc
public LocatorRecordBuilder setRloc(Rloc value)
Set the property corresponding toRlocContainer.getRloc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRlocProbed
public LocatorRecordBuilder setRlocProbed(java.lang.Boolean value)
Set the property corresponding toLocatorRecord.getRlocProbed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouted
public LocatorRecordBuilder setRouted(java.lang.Boolean value)
Set the property corresponding toLocatorRecord.getRouted()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWeight
public LocatorRecordBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLocatorRecord.getWeight()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LocatorRecordBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocatorRecord> 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 LocatorRecordBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorRecord>> 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 LocatorRecord build()
A newLocatorRecord
instance.- Returns:
- A new
LocatorRecord
instance.
-
-