Class SvecBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.SvecBuilder
-
@Generated("mdsal-binding-generator") public class SvecBuilder extends Object
Class that buildsSvec
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:
Svec createSvec(int fooXyzzy, int barBaz) { return new SvecBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Svec, 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:
Svec
- 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 SvecBuilder()
Construct an empty builder.SvecBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.SvecBuilder(GcObject arg)
Construct a new builder initialized from specifiedGcObject
.SvecBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.SvecBuilder(Svec base)
Construct a builder initialized with state from specifiedSvec
.SvecBuilder(SvecObject arg)
Construct a new builder initialized from specifiedSvecObject
.SvecBuilder(VendorInformationObjects arg)
Construct a new builder initialized from specifiedVendorInformationObjects
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SvecBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Svec> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Svec
build()
A newSvec
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Gc
getGc()
Return current value associated with the property corresponding toGcObject.getGc()
.List<Metric>
getMetric()
Return current value associated with the property corresponding toSvec.getMetric()
.Of
getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.Svec
getSvec()
Return current value associated with the property corresponding toSvecObject.getSvec()
.List<VendorInformationObject>
getVendorInformationObject()
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.Xro
getXro()
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.SvecBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> augmentationType)
Remove an augmentation from this builder's product.SvecBuilder
setGc(Gc value)
Set the property corresponding toGcObject.getGc()
to the specified value.SvecBuilder
setMetric(List<Metric> values)
Set the property corresponding toSvec.getMetric()
to the specified value.SvecBuilder
setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.SvecBuilder
setSvec(Svec value)
Set the property corresponding toSvecObject.getSvec()
to the specified value.SvecBuilder
setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.SvecBuilder
setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.
-
-
-
Constructor Detail
-
SvecBuilder
public SvecBuilder()
Construct an empty builder.
-
SvecBuilder
public SvecBuilder(SvecObject arg)
Construct a new builder initialized from specifiedSvecObject
.- Parameters:
arg
- SvecObject from which the builder should be initialized
-
SvecBuilder
public SvecBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.- Parameters:
arg
- OfObject from which the builder should be initialized
-
SvecBuilder
public SvecBuilder(GcObject arg)
Construct a new builder initialized from specifiedGcObject
.- Parameters:
arg
- GcObject from which the builder should be initialized
-
SvecBuilder
public SvecBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.- Parameters:
arg
- ExcludeRouteObject from which the builder should be initialized
-
SvecBuilder
public SvecBuilder(VendorInformationObjects arg)
Construct a new builder initialized from specifiedVendorInformationObjects
.- Parameters:
arg
- VendorInformationObjects 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
-
getGc
public Gc getGc()
Return current value associated with the property corresponding toGcObject.getGc()
.- Returns:
- current value
-
getMetric
public List<Metric> getMetric()
Return current value associated with the property corresponding toSvec.getMetric()
.- Returns:
- current value
-
getOf
public Of getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.- Returns:
- current value
-
getSvec
public Svec getSvec()
Return current value associated with the property corresponding toSvecObject.getSvec()
.- Returns:
- current value
-
getVendorInformationObject
public List<VendorInformationObject> getVendorInformationObject()
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.- Returns:
- current value
-
getXro
public Xro getXro()
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> 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
-
setGc
public SvecBuilder setGc(Gc value)
Set the property corresponding toGcObject.getGc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetric
public SvecBuilder setMetric(List<Metric> values)
Set the property corresponding toSvec.getMetric()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setOf
public SvecBuilder setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSvec
public SvecBuilder setSvec(Svec value)
Set the property corresponding toSvecObject.getSvec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVendorInformationObject
public SvecBuilder setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setXro
public SvecBuilder setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SvecBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Svec> 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 SvecBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> 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
-
-