Class LspDbVersionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev200720.lsp.db.version.tlv.LspDbVersionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LspDbVersion>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LspDbVersion,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LspDbVersionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LspDbVersion>
Class that buildsLspDbVersionBuilder
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:
LspDbVersionBuilder createTarget(int fooXyzzy, int barBaz) { return new LspDbVersionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LspDbVersionBuilder, 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:
LspDbVersionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LspDbVersionBuilder()
LspDbVersionBuilder(LspDbVersion base)
LspDbVersionBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description LspDbVersionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LspDbVersion> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LspDbVersion>>
E$$augmentation(Class<E$$> augmentationType)
LspDbVersion
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getLspDbVersionValue()
LspDbVersionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspDbVersion>> augmentationType)
Remove an augmentation from this builder's product.LspDbVersionBuilder
setLspDbVersionValue(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLspDbVersionValue(Uint64)
instead.LspDbVersionBuilder
setLspDbVersionValue(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
LspDbVersionBuilder
public LspDbVersionBuilder()
-
LspDbVersionBuilder
public LspDbVersionBuilder(Tlv arg)
-
LspDbVersionBuilder
public LspDbVersionBuilder(LspDbVersion 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.Tlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLspDbVersionValue
public org.opendaylight.yangtools.yang.common.Uint64 getLspDbVersionValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LspDbVersion>> E$$ augmentation(Class<E$$> augmentationType)
-
setLspDbVersionValue
public LspDbVersionBuilder setLspDbVersionValue(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setLspDbVersionValue
@Deprecated(forRemoval=true) public LspDbVersionBuilder setLspDbVersionValue(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLspDbVersionValue(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public LspDbVersionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LspDbVersion> 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 LspDbVersionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspDbVersion>> 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 LspDbVersion build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LspDbVersion>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LspDbVersion,IllegalArgumentException>
-
-