Class PathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcrpt.message.pcrpt.message.reports.PathBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Path>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Path,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PathBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Path>
Class that buildsPathBuilder
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:
PathBuilder createTarget(int fooXyzzy, int barBaz) { return new PathBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathBuilder, 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 oportunities, 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:
PathBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PathBuilder()
PathBuilder(Path base)
PathBuilder(BandwidthObject arg)
PathBuilder(ClasstypeObject arg)
PathBuilder(ExcludeRouteObject arg)
PathBuilder(ExplicitRouteObject arg)
PathBuilder(IncludeRouteObject arg)
PathBuilder(LspaObject arg)
PathBuilder(LspAttributes arg)
PathBuilder(OfObject arg)
PathBuilder(PathDefinition arg)
PathBuilder(ReoptimizationBandwidthObject arg)
PathBuilder(ReportedRouteObject arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Path> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Path>>
E$$augmentation(Class<E$$> augmentationType)
Path
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
ClassType
getClassType()
Ero
getEro()
Iro
getIro()
Lspa
getLspa()
List<Metrics>
getMetrics()
Of
getOf()
ReoptimizationBandwidth
getReoptimizationBandwidth()
Rro
getRro()
Xro
getXro()
PathBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Path>> augmentationType)
Remove an augmentation from this builder's product.PathBuilder
setBandwidth(Bandwidth value)
PathBuilder
setClassType(ClassType value)
PathBuilder
setEro(Ero value)
PathBuilder
setIro(Iro value)
PathBuilder
setLspa(Lspa value)
PathBuilder
setMetrics(List<Metrics> values)
PathBuilder
setOf(Of value)
PathBuilder
setReoptimizationBandwidth(ReoptimizationBandwidth value)
PathBuilder
setRro(Rro value)
PathBuilder
setXro(Xro value)
-
-
-
Constructor Detail
-
PathBuilder
public PathBuilder()
-
PathBuilder
public PathBuilder(PathDefinition arg)
-
PathBuilder
public PathBuilder(ExplicitRouteObject arg)
-
PathBuilder
public PathBuilder(LspAttributes arg)
-
PathBuilder
public PathBuilder(LspaObject arg)
-
PathBuilder
public PathBuilder(BandwidthObject arg)
-
PathBuilder
public PathBuilder(ReoptimizationBandwidthObject arg)
-
PathBuilder
public PathBuilder(IncludeRouteObject arg)
-
PathBuilder
public PathBuilder(ReportedRouteObject arg)
-
PathBuilder
public PathBuilder(ExcludeRouteObject arg)
-
PathBuilder
public PathBuilder(OfObject arg)
-
PathBuilder
public PathBuilder(ClasstypeObject arg)
-
PathBuilder
public PathBuilder(Path 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ClasstypeObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ReoptimizationBandwidthObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.BandwidthObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.OfObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PathDefinition
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ReportedRouteObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.LspAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.IncludeRouteObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ExcludeRouteObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.LspaObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ExplicitRouteObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBandwidth
public Bandwidth getBandwidth()
-
getClassType
public ClassType getClassType()
-
getEro
public Ero getEro()
-
getIro
public Iro getIro()
-
getLspa
public Lspa getLspa()
-
getOf
public Of getOf()
-
getReoptimizationBandwidth
public ReoptimizationBandwidth getReoptimizationBandwidth()
-
getRro
public Rro getRro()
-
getXro
public Xro getXro()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Path>> E$$ augmentation(Class<E$$> augmentationType)
-
setBandwidth
public PathBuilder setBandwidth(Bandwidth value)
-
setClassType
public PathBuilder setClassType(ClassType value)
-
setEro
public PathBuilder setEro(Ero value)
-
setIro
public PathBuilder setIro(Iro value)
-
setLspa
public PathBuilder setLspa(Lspa value)
-
setMetrics
public PathBuilder setMetrics(List<Metrics> values)
-
setOf
public PathBuilder setOf(Of value)
-
setReoptimizationBandwidth
public PathBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)
-
setRro
public PathBuilder setRro(Rro value)
-
setXro
public PathBuilder setXro(Xro value)
-
addAugmentation
public PathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Path> 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 PathBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Path>> 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 Path build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Path>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Path,IllegalArgumentException>
-
-