Class LspErrorCodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.error.code.tlv.LspErrorCodeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LspErrorCode>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LspErrorCode,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class LspErrorCodeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LspErrorCode>
Class that buildsLspErrorCodeBuilder
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:
LspErrorCodeBuilder createTarget(int fooXyzzy, int barBaz) { return new LspErrorCodeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LspErrorCodeBuilder, 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:
LspErrorCodeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LspErrorCodeBuilder()
LspErrorCodeBuilder(LspErrorCode base)
LspErrorCodeBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description LspErrorCodeBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode>>
E$$augmentation(Class<E$$> augmentationType)
LspErrorCode
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getErrorCode()
LspErrorCodeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode>> augmentationType)
LspErrorCodeBuilder
setErrorCode(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setErrorCode(Uint32)} instead.LspErrorCodeBuilder
setErrorCode(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
LspErrorCodeBuilder
public LspErrorCodeBuilder()
-
LspErrorCodeBuilder
public LspErrorCodeBuilder(Tlv arg)
-
LspErrorCodeBuilder
public LspErrorCodeBuilder(LspErrorCode 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
-
getErrorCode
public org.opendaylight.yangtools.yang.common.Uint32 getErrorCode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode>> E$$ augmentation(Class<E$$> augmentationType)
-
setErrorCode
public LspErrorCodeBuilder setErrorCode(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setErrorCode
@Deprecated(forRemoval=true) public LspErrorCodeBuilder setErrorCode(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setErrorCode(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public LspErrorCodeBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode> augmentationValue)
-
removeAugmentation
public LspErrorCodeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspErrorCode>> augmentationType)
-
build
public LspErrorCode build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LspErrorCode>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LspErrorCode,IllegalArgumentException>
-
-