Class ArgumentsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.update.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>
@Generated("mdsal-binding-generator") 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(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(LspMetadata arg)
ArgumentsBuilder(Arguments base)
-
Method Summary
-
-
-
Constructor Detail
-
ArgumentsBuilder
public ArgumentsBuilder()
-
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.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.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()
-
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)
-
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
-
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>
-
-