Class ReportedLspBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.path.computation.client.ReportedLspBuilder
-
@Generated("mdsal-binding-generator") public class ReportedLspBuilder extends Object
Class that buildsReportedLsp
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:
ReportedLsp createReportedLsp(int fooXyzzy, int barBaz) { return new ReportedLspBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ReportedLsp, 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:
ReportedLsp
- 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 ReportedLspBuilder()
Construct an empty builder.ReportedLspBuilder(LspMetadata arg)
Construct a new builder initialized from specifiedLspMetadata
.ReportedLspBuilder(ReportedLsp base)
Construct a builder initialized with state from specifiedReportedLsp
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReportedLspBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReportedLsp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedLsp>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ReportedLsp
build()
A newReportedLsp
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Metadata
getMetadata()
Return current value associated with the property corresponding toLspMetadata.getMetadata()
.String
getName()
Return current value associated with the property corresponding toReportedLsp.getName()
.Map<PathKey,Path>
getPath()
Return current value associated with the property corresponding toReportedLsp.getPath()
.ReportedLspKey
key()
Return current value associated with the property corresponding toReportedLsp.key()
.ReportedLspBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedLsp>> augmentationType)
Remove an augmentation from this builder's product.ReportedLspBuilder
setMetadata(Metadata value)
Set the property corresponding toLspMetadata.getMetadata()
to the specified value.ReportedLspBuilder
setName(String value)
Set the property corresponding toReportedLsp.getName()
to the specified value.ReportedLspBuilder
setPath(Map<PathKey,Path> values)
Set the property corresponding toReportedLsp.getPath()
to the specified value.ReportedLspBuilder
withKey(ReportedLspKey key)
-
-
-
Constructor Detail
-
ReportedLspBuilder
public ReportedLspBuilder()
Construct an empty builder.
-
ReportedLspBuilder
public ReportedLspBuilder(LspMetadata arg)
Construct a new builder initialized from specifiedLspMetadata
.- Parameters:
arg
- LspMetadata from which the builder should be initialized
-
ReportedLspBuilder
public ReportedLspBuilder(ReportedLsp base)
Construct a builder initialized with state from specifiedReportedLsp
.- Parameters:
base
- ReportedLsp 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:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public ReportedLspKey key()
Return current value associated with the property corresponding toReportedLsp.key()
.- Returns:
- current value
-
getMetadata
public Metadata getMetadata()
Return current value associated with the property corresponding toLspMetadata.getMetadata()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toReportedLsp.getName()
.- Returns:
- current value
-
getPath
public Map<PathKey,Path> getPath()
Return current value associated with the property corresponding toReportedLsp.getPath()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedLsp>> 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
-
withKey
public ReportedLspBuilder withKey(ReportedLspKey key)
-
setMetadata
public ReportedLspBuilder setMetadata(Metadata value)
Set the property corresponding toLspMetadata.getMetadata()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public ReportedLspBuilder setName(String value)
Set the property corresponding toReportedLsp.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPath
public ReportedLspBuilder setPath(Map<PathKey,Path> values)
Set the property corresponding toReportedLsp.getPath()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public ReportedLspBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReportedLsp> 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 ReportedLspBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedLsp>> 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 ReportedLsp build()
A newReportedLsp
instance.- Returns:
- A new
ReportedLsp
instance.
-
-