Class ErrorObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object.ErrorObjectBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ErrorObject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ErrorObject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ErrorObjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ErrorObject>
Class that buildsErrorObjectBuilder
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:
ErrorObjectBuilder createTarget(int fooXyzzy, int barBaz) { return new ErrorObjectBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ErrorObjectBuilder, 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:
ErrorObjectBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ErrorObjectBuilder()
ErrorObjectBuilder(Object arg)
ErrorObjectBuilder(ObjectHeader arg)
ErrorObjectBuilder(ErrorObject base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ErrorObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject>>
E$$augmentation(Class<E$$> augmentationType)
ErrorObject
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
Boolean
getProcessingRule()
Tlvs
getTlvs()
org.opendaylight.yangtools.yang.common.Uint8
getType()
org.opendaylight.yangtools.yang.common.Uint8
getValue()
Boolean
isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.ErrorObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject>> augmentationType)
Remove an augmentation from this builder's product.ErrorObjectBuilder
setIgnore(Boolean value)
ErrorObjectBuilder
setProcessingRule(Boolean value)
ErrorObjectBuilder
setTlvs(Tlvs value)
ErrorObjectBuilder
setType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetType(Uint8)
instead.ErrorObjectBuilder
setType(org.opendaylight.yangtools.yang.common.Uint8 value)
ErrorObjectBuilder
setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint8)
instead.ErrorObjectBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
ErrorObjectBuilder
public ErrorObjectBuilder()
-
ErrorObjectBuilder
public ErrorObjectBuilder(Object arg)
-
ErrorObjectBuilder
public ErrorObjectBuilder(ObjectHeader arg)
-
ErrorObjectBuilder
public ErrorObjectBuilder(ErrorObject 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 or has property with incompatible value
-
getIgnore
public Boolean getIgnore()
-
isIgnore
@Deprecated(forRemoval=true) public final Boolean isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getProcessingRule
public Boolean getProcessingRule()
-
isProcessingRule
@Deprecated(forRemoval=true) public final Boolean isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getTlvs
public Tlvs getTlvs()
-
getType
public org.opendaylight.yangtools.yang.common.Uint8 getType()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject>> E$$ augmentation(Class<E$$> augmentationType)
-
setIgnore
public ErrorObjectBuilder setIgnore(Boolean value)
-
setProcessingRule
public ErrorObjectBuilder setProcessingRule(Boolean value)
-
setTlvs
public ErrorObjectBuilder setTlvs(Tlvs value)
-
setType
public ErrorObjectBuilder setType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setType
@Deprecated(forRemoval=true) public ErrorObjectBuilder setType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetType(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setValue
public ErrorObjectBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
@Deprecated(forRemoval=true) public ErrorObjectBuilder setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public ErrorObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject> 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 ErrorObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorObject>> 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 ErrorObject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ErrorObject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ErrorObject,IllegalArgumentException>
-
-