Class LastReceivedErrorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.error.messages.grouping.error.messages.LastReceivedErrorBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LastReceivedError>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LastReceivedError,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LastReceivedErrorBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LastReceivedError>
Class that buildsLastReceivedError
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:
LastReceivedError createLastReceivedError(int fooXyzzy, int barBaz) { return new LastReceivedErrorBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LastReceivedError, 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:
LastReceivedError
,Builder
-
-
Constructor Summary
Constructors Constructor Description LastReceivedErrorBuilder()
LastReceivedErrorBuilder(Error arg)
LastReceivedErrorBuilder(LastReceivedError base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LastReceivedErrorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LastReceivedError> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LastReceivedError>>
E$$augmentation(Class<E$$> augmentationType)
LastReceivedError
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getErrorType()
org.opendaylight.yangtools.yang.common.Uint8
getErrorValue()
LastReceivedErrorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LastReceivedError>> augmentationType)
Remove an augmentation from this builder's product.LastReceivedErrorBuilder
setErrorType(org.opendaylight.yangtools.yang.common.Uint8 value)
LastReceivedErrorBuilder
setErrorValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
LastReceivedErrorBuilder
public LastReceivedErrorBuilder()
-
LastReceivedErrorBuilder
public LastReceivedErrorBuilder(Error arg)
-
LastReceivedErrorBuilder
public LastReceivedErrorBuilder(LastReceivedError 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:- Error
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getErrorType
public org.opendaylight.yangtools.yang.common.Uint8 getErrorType()
-
getErrorValue
public org.opendaylight.yangtools.yang.common.Uint8 getErrorValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LastReceivedError>> E$$ augmentation(Class<E$$> augmentationType)
-
setErrorType
public LastReceivedErrorBuilder setErrorType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setErrorValue
public LastReceivedErrorBuilder setErrorValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public LastReceivedErrorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LastReceivedError> 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 LastReceivedErrorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LastReceivedError>> 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 LastReceivedError build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LastReceivedError>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LastReceivedError,IllegalArgumentException>
-
-