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
-
- 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>
public class SvecBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Svec>
Class that buildsSvecBuilder
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:
SvecBuilder createTarget(int fooXyzzy, int barBaz) { return new SvecBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SvecBuilder, 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:
SvecBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SvecBuilder()
SvecBuilder(Object arg)
SvecBuilder(ObjectHeader arg)
SvecBuilder(Svec base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SvecBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Svec> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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.List<RequestId>
getRequestsIds()
Boolean
isIgnore()
Boolean
isLinkDirectionDiverse()
Boolean
isLinkDiverse()
Boolean
isNodeDiverse()
Boolean
isPartialPathDiverse()
Boolean
isProcessingRule()
Boolean
isSrlgDiverse()
SvecBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> augmentationType)
Remove an augmentation from this builder's product.SvecBuilder
setIgnore(Boolean value)
SvecBuilder
setLinkDirectionDiverse(Boolean value)
SvecBuilder
setLinkDiverse(Boolean value)
SvecBuilder
setNodeDiverse(Boolean value)
SvecBuilder
setPartialPathDiverse(Boolean value)
SvecBuilder
setProcessingRule(Boolean value)
SvecBuilder
setRequestsIds(List<RequestId> values)
SvecBuilder
setSrlgDiverse(Boolean value)
-
-
-
Constructor Detail
-
SvecBuilder
public SvecBuilder()
-
SvecBuilder
public SvecBuilder(Object arg)
-
SvecBuilder
public SvecBuilder(ObjectHeader 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
isIgnore
public Boolean isIgnore()
-
isLinkDirectionDiverse
public Boolean isLinkDirectionDiverse()
-
isLinkDiverse
public Boolean isLinkDiverse()
-
isNodeDiverse
public Boolean isNodeDiverse()
-
isPartialPathDiverse
public Boolean isPartialPathDiverse()
-
isProcessingRule
public Boolean isProcessingRule()
-
isSrlgDiverse
public Boolean isSrlgDiverse()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> E$$ augmentation(Class<E$$> augmentationType)
-
setRequestsIds
public SvecBuilder setRequestsIds(List<RequestId> values)
-
setIgnore
public SvecBuilder setIgnore(Boolean value)
-
setLinkDirectionDiverse
public SvecBuilder setLinkDirectionDiverse(Boolean value)
-
setLinkDiverse
public SvecBuilder setLinkDiverse(Boolean value)
-
setNodeDiverse
public SvecBuilder setNodeDiverse(Boolean value)
-
setPartialPathDiverse
public SvecBuilder setPartialPathDiverse(Boolean value)
-
setProcessingRule
public SvecBuilder setProcessingRule(Boolean value)
-
setSrlgDiverse
public SvecBuilder setSrlgDiverse(Boolean 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
-
addAugmentation
@Deprecated(forRemoval=true) public SvecBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Svec>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Svec> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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>
-
-