Class SvecBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.SvecBuilder
Class that builds
Svec
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.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
.Construct a new builder initialized from specifiedVendorInformationObjects
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Svec> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.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.binding.Grouping arg) Set fields from given grouping argument.getGc()
Return current value associated with the property corresponding toGcObject.getGc()
.Return current value associated with the property corresponding toSvec.getMetric()
.getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.getSvec()
Return current value associated with the property corresponding toSvecObject.getSvec()
.Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.getXro()
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Svec>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toGcObject.getGc()
to the specified value.Set the property corresponding toSvec.getMetric()
to the specified value.Set the property corresponding toOfObject.getOf()
to the specified value.Set the property corresponding toSvecObject.getSvec()
to the specified value.Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.
-
Constructor Details
-
SvecBuilder
public SvecBuilder()Construct an empty builder. -
SvecBuilder
Construct a new builder initialized from specifiedSvecObject
.- Parameters:
arg
- SvecObject from which the builder should be initialized
-
SvecBuilder
Construct a new builder initialized from specifiedOfObject
.- Parameters:
arg
- OfObject from which the builder should be initialized
-
SvecBuilder
Construct a new builder initialized from specifiedGcObject
.- Parameters:
arg
- GcObject from which the builder should be initialized
-
SvecBuilder
Construct a new builder initialized from specifiedExcludeRouteObject
.- Parameters:
arg
- ExcludeRouteObject from which the builder should be initialized
-
SvecBuilder
Construct a new builder initialized from specifiedVendorInformationObjects
.- Parameters:
arg
- VendorInformationObjects from which the builder should be initialized
-
SvecBuilder
Construct a builder initialized with state from specifiedSvec
.- Parameters:
base
- Svec from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
Return current value associated with the property corresponding toGcObject.getGc()
.- Returns:
- current value
-
getMetric
Return current value associated with the property corresponding toSvec.getMetric()
.- Returns:
- current value
-
getOf
Return current value associated with the property corresponding toOfObject.getOf()
.- Returns:
- current value
-
getSvec
Return current value associated with the property corresponding toSvecObject.getSvec()
.- Returns:
- current value
-
getVendorInformationObject
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.- Returns:
- current value
-
getXro
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.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
Set the property corresponding toGcObject.getGc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetric
Set the property corresponding toSvec.getMetric()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setOf
Set the property corresponding toOfObject.getOf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSvec
Set the property corresponding toSvecObject.getSvec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVendorInformationObject
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setXro
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SvecBuilder addAugmentation(org.opendaylight.yangtools.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.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
-
build
A newSvec
instance.- Returns:
- A new
Svec
instance.
-