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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ReportedLsp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ReportedLsp,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ReportedLspBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ReportedLsp>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description ReportedLspBuilder()
ReportedLspBuilder(LspMetadata arg)
ReportedLspBuilder(ReportedLsp base)
-
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)
ReportedLsp
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Metadata
getMetadata()
String
getName()
Map<PathKey,Path>
getPath()
ReportedLspKey
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)
ReportedLspBuilder
setName(String value)
ReportedLspBuilder
setPath(Map<PathKey,Path> values)
ReportedLspBuilder
withKey(ReportedLspKey key)
-
-
-
Constructor Detail
-
ReportedLspBuilder
public ReportedLspBuilder()
-
ReportedLspBuilder
public ReportedLspBuilder(LspMetadata arg)
-
ReportedLspBuilder
public ReportedLspBuilder(ReportedLsp base)
-
-
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:- LspMetadata
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public ReportedLspKey key()
-
getMetadata
public Metadata getMetadata()
-
getName
public String getName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedLsp>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ReportedLspBuilder withKey(ReportedLspKey key)
-
setMetadata
public ReportedLspBuilder setMetadata(Metadata value)
-
setName
public ReportedLspBuilder setName(String value)
-
setPath
public ReportedLspBuilder setPath(Map<PathKey,Path> values)
-
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 ReportedLsp build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ReportedLsp>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ReportedLsp,IllegalArgumentException>
-
-