Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.svec.object
Class SvecBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.svec.object.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(Object arg)
Construct a new builder initialized from specifiedObject
.SvecBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.SvecBuilder(Svec base)
Construct a builder initialized with state from specifiedSvec
.
-
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.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Boolean
getLinkDirectionDiverse()
Return current value associated with the property corresponding toSvec.getLinkDirectionDiverse()
.Boolean
getLinkDiverse()
Return current value associated with the property corresponding toSvec.getLinkDiverse()
.Boolean
getNodeDiverse()
Return current value associated with the property corresponding toSvec.getNodeDiverse()
.Boolean
getPartialPathDiverse()
Return current value associated with the property corresponding toSvec.getPartialPathDiverse()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Set<RequestId>
getRequestsIds()
Return current value associated with the property corresponding toSvec.getRequestsIds()
.Boolean
getSrlgDiverse()
Return current value associated with the property corresponding toSvec.getSrlgDiverse()
.SvecBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> augmentationType)
Remove an augmentation from this builder's product.SvecBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.SvecBuilder
setLinkDirectionDiverse(Boolean value)
Set the property corresponding toSvec.getLinkDirectionDiverse()
to the specified value.SvecBuilder
setLinkDiverse(Boolean value)
Set the property corresponding toSvec.getLinkDiverse()
to the specified value.SvecBuilder
setNodeDiverse(Boolean value)
Set the property corresponding toSvec.getNodeDiverse()
to the specified value.SvecBuilder
setPartialPathDiverse(Boolean value)
Set the property corresponding toSvec.getPartialPathDiverse()
to the specified value.SvecBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.SvecBuilder
setRequestsIds(Set<RequestId> values)
Set the property corresponding toSvec.getRequestsIds()
to the specified value.SvecBuilder
setSrlgDiverse(Boolean value)
Set the property corresponding toSvec.getSrlgDiverse()
to the specified value.
-
-
-
Constructor Detail
-
SvecBuilder
public SvecBuilder()
Construct an empty builder.
-
SvecBuilder
public SvecBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
SvecBuilder
public SvecBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader 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
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getLinkDirectionDiverse
public Boolean getLinkDirectionDiverse()
Return current value associated with the property corresponding toSvec.getLinkDirectionDiverse()
.- Returns:
- current value
-
getLinkDiverse
public Boolean getLinkDiverse()
Return current value associated with the property corresponding toSvec.getLinkDiverse()
.- Returns:
- current value
-
getNodeDiverse
public Boolean getNodeDiverse()
Return current value associated with the property corresponding toSvec.getNodeDiverse()
.- Returns:
- current value
-
getPartialPathDiverse
public Boolean getPartialPathDiverse()
Return current value associated with the property corresponding toSvec.getPartialPathDiverse()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getRequestsIds
public Set<RequestId> getRequestsIds()
Return current value associated with the property corresponding toSvec.getRequestsIds()
.- Returns:
- current value
-
getSrlgDiverse
public Boolean getSrlgDiverse()
Return current value associated with the property corresponding toSvec.getSrlgDiverse()
.- 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
-
setIgnore
public SvecBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLinkDirectionDiverse
public SvecBuilder setLinkDirectionDiverse(Boolean value)
Set the property corresponding toSvec.getLinkDirectionDiverse()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLinkDiverse
public SvecBuilder setLinkDiverse(Boolean value)
Set the property corresponding toSvec.getLinkDiverse()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNodeDiverse
public SvecBuilder setNodeDiverse(Boolean value)
Set the property corresponding toSvec.getNodeDiverse()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPartialPathDiverse
public SvecBuilder setPartialPathDiverse(Boolean value)
Set the property corresponding toSvec.getPartialPathDiverse()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public SvecBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRequestsIds
public SvecBuilder setRequestsIds(Set<RequestId> values)
Set the property corresponding toSvec.getRequestsIds()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSrlgDiverse
public SvecBuilder setSrlgDiverse(Boolean value)
Set the property corresponding toSvec.getSrlgDiverse()
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
-
-