Class SvecBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.SvecBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Svec>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Svec,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SvecBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Svec>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description SvecBuilder()
SvecBuilder(ExcludeRouteObject arg)
SvecBuilder(GcObject arg)
SvecBuilder(OfObject arg)
SvecBuilder(Svec base)
SvecBuilder(SvecObject arg)
SvecBuilder(VendorInformationObjects arg)
-
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)
Svec
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Gc
getGc()
List<Metric>
getMetric()
Of
getOf()
Svec
getSvec()
List<VendorInformationObject>
getVendorInformationObject()
Xro
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)
SvecBuilder
setMetric(List<Metric> values)
SvecBuilder
setOf(Of value)
SvecBuilder
setSvec(Svec value)
SvecBuilder
setVendorInformationObject(List<VendorInformationObject> values)
SvecBuilder
setXro(Xro value)
-
-
-
Constructor Detail
-
SvecBuilder
public SvecBuilder()
-
SvecBuilder
public SvecBuilder(SvecObject arg)
-
SvecBuilder
public SvecBuilder(OfObject arg)
-
SvecBuilder
public SvecBuilder(GcObject arg)
-
SvecBuilder
public SvecBuilder(ExcludeRouteObject arg)
-
SvecBuilder
public SvecBuilder(VendorInformationObjects arg)
-
SvecBuilder
public SvecBuilder(Svec 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:- SvecObject
- OfObject
- ExcludeRouteObject
- GcObject
- VendorInformationObjects
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getGc
public Gc getGc()
-
getOf
public Of getOf()
-
getSvec
public Svec getSvec()
-
getVendorInformationObject
public List<VendorInformationObject> getVendorInformationObject()
-
getXro
public Xro getXro()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> E$$ augmentation(Class<E$$> augmentationType)
-
setGc
public SvecBuilder setGc(Gc value)
-
setMetric
public SvecBuilder setMetric(List<Metric> values)
-
setOf
public SvecBuilder setOf(Of value)
-
setSvec
public SvecBuilder setSvec(Svec value)
-
setVendorInformationObject
public SvecBuilder setVendorInformationObject(List<VendorInformationObject> values)
-
setXro
public SvecBuilder setXro(Xro value)
-
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
-
build
public Svec build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Svec>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Svec,IllegalArgumentException>
-
-