Class ArgumentsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.add.lsp.args.ArgumentsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Arguments>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Arguments,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ArgumentsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Arguments>
Class that buildsArgumentsBuilder
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:
ArgumentsBuilder createTarget(int fooXyzzy, int barBaz) { return new ArgumentsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ArgumentsBuilder, 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:
ArgumentsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ArgumentsBuilder()
ArgumentsBuilder(BandwidthObject arg)
ArgumentsBuilder(ClasstypeObject arg)
ArgumentsBuilder(EndpointsObject arg)
ArgumentsBuilder(ExcludeRouteObject arg)
ArgumentsBuilder(ExplicitRouteObject arg)
ArgumentsBuilder(IncludeRouteObject arg)
ArgumentsBuilder(LspaObject arg)
ArgumentsBuilder(LspAttributes arg)
ArgumentsBuilder(OfObject arg)
ArgumentsBuilder(PathDefinition arg)
ArgumentsBuilder(ReoptimizationBandwidthObject arg)
ArgumentsBuilder(ReportedRouteObject arg)
ArgumentsBuilder(Arguments base)
ArgumentsBuilder(LspMetadata arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ArgumentsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Arguments>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Arguments> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.ArgumentsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Arguments> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Arguments>>
E$$augmentation(Class<E$$> augmentationType)
Arguments
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
ClassType
getClassType()
EndpointsObj
getEndpointsObj()
Ero
getEro()
Iro
getIro()
Lspa
getLspa()
Metadata
getMetadata()
List<Metrics>
getMetrics()
Of
getOf()
ReoptimizationBandwidth
getReoptimizationBandwidth()
Rro
getRro()
Xro
getXro()
ArgumentsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Arguments>> augmentationType)
Remove an augmentation from this builder's product.ArgumentsBuilder
setBandwidth(Bandwidth value)
ArgumentsBuilder
setClassType(ClassType value)
ArgumentsBuilder
setEndpointsObj(EndpointsObj value)
ArgumentsBuilder
setEro(Ero value)
ArgumentsBuilder
setIro(Iro value)
ArgumentsBuilder
setLspa(Lspa value)
ArgumentsBuilder
setMetadata(Metadata value)
ArgumentsBuilder
setMetrics(List<Metrics> values)
ArgumentsBuilder
setOf(Of value)
ArgumentsBuilder
setReoptimizationBandwidth(ReoptimizationBandwidth value)
ArgumentsBuilder
setRro(Rro value)
ArgumentsBuilder
setXro(Xro value)
-
-
-
Constructor Detail
-
ArgumentsBuilder
public ArgumentsBuilder()
-
ArgumentsBuilder
public ArgumentsBuilder(EndpointsObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(PathDefinition arg)
-
ArgumentsBuilder
public ArgumentsBuilder(ExplicitRouteObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(LspAttributes arg)
-
ArgumentsBuilder
public ArgumentsBuilder(LspaObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(BandwidthObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(ReoptimizationBandwidthObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(IncludeRouteObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(ReportedRouteObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(ExcludeRouteObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(OfObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(ClasstypeObject arg)
-
ArgumentsBuilder
public ArgumentsBuilder(LspMetadata arg)
-
ArgumentsBuilder
public ArgumentsBuilder(Arguments 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.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.IncludeRouteObject
- 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
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.LspMetadata
- 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.ReportedRouteObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.EndpointsObject
- 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.ExcludeRouteObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getBandwidth
public Bandwidth getBandwidth()
-
getClassType
public ClassType getClassType()
-
getEndpointsObj
public EndpointsObj getEndpointsObj()
-
getEro
public Ero getEro()
-
getIro
public Iro getIro()
-
getLspa
public Lspa getLspa()
-
getMetadata
public Metadata getMetadata()
-
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<Arguments>> E$$ augmentation(Class<E$$> augmentationType)
-
setBandwidth
public ArgumentsBuilder setBandwidth(Bandwidth value)
-
setClassType
public ArgumentsBuilder setClassType(ClassType value)
-
setEndpointsObj
public ArgumentsBuilder setEndpointsObj(EndpointsObj value)
-
setEro
public ArgumentsBuilder setEro(Ero value)
-
setIro
public ArgumentsBuilder setIro(Iro value)
-
setLspa
public ArgumentsBuilder setLspa(Lspa value)
-
setMetadata
public ArgumentsBuilder setMetadata(Metadata value)
-
setMetrics
public ArgumentsBuilder setMetrics(List<Metrics> values)
-
setOf
public ArgumentsBuilder setOf(Of value)
-
setReoptimizationBandwidth
public ArgumentsBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)
-
setRro
public ArgumentsBuilder setRro(Rro value)
-
setXro
public ArgumentsBuilder setXro(Xro value)
-
addAugmentation
public ArgumentsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Arguments> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public ArgumentsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Arguments>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Arguments> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public ArgumentsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Arguments>> 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 Arguments build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Arguments>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Arguments,IllegalArgumentException>
-
-