Class LastSentErrorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.error.messages.grouping.error.messages.LastSentErrorBuilder
-
@Generated("mdsal-binding-generator") public class LastSentErrorBuilder extends Object
Class that buildsLastSentError
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:
LastSentError createLastSentError(int fooXyzzy, int barBaz) { return new LastSentErrorBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LastSentError, 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:
LastSentError
- 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
-
-
Constructor Summary
Constructors Constructor Description LastSentErrorBuilder()
Construct an empty builder.LastSentErrorBuilder(Error arg)
Construct a new builder initialized from specifiedError
.LastSentErrorBuilder(LastSentError base)
Construct a builder initialized with state from specifiedLastSentError
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LastSentErrorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LastSentError> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LastSentError>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LastSentError
build()
A newLastSentError
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getErrorType()
Return current value associated with the property corresponding toError.getErrorType()
.org.opendaylight.yangtools.yang.common.Uint8
getErrorValue()
Return current value associated with the property corresponding toError.getErrorValue()
.LastSentErrorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LastSentError>> augmentationType)
Remove an augmentation from this builder's product.LastSentErrorBuilder
setErrorType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toError.getErrorType()
to the specified value.LastSentErrorBuilder
setErrorValue(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toError.getErrorValue()
to the specified value.
-
-
-
Constructor Detail
-
LastSentErrorBuilder
public LastSentErrorBuilder()
Construct an empty builder.
-
LastSentErrorBuilder
public LastSentErrorBuilder(Error arg)
Construct a new builder initialized from specifiedError
.- Parameters:
arg
- Error from which the builder should be initialized
-
LastSentErrorBuilder
public LastSentErrorBuilder(LastSentError base)
Construct a builder initialized with state from specifiedLastSentError
.- Parameters:
base
- LastSentError from which the builder should be initialized
-
-
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:- 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()
Return current value associated with the property corresponding toError.getErrorType()
.- Returns:
- current value
-
getErrorValue
public org.opendaylight.yangtools.yang.common.Uint8 getErrorValue()
Return current value associated with the property corresponding toError.getErrorValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LastSentError>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setErrorType
public LastSentErrorBuilder setErrorType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toError.getErrorType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setErrorValue
public LastSentErrorBuilder setErrorValue(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toError.getErrorValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LastSentErrorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LastSentError> 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 LastSentErrorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LastSentError>> 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 @NonNull LastSentError build()
A newLastSentError
instance.- Returns:
- A new
LastSentError
instance.
-
-