Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message
Class PcerrMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.PcerrMessageBuilder
-
@Generated("mdsal-binding-generator") public class PcerrMessageBuilder extends Object
Class that buildsPcerrMessage
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:
PcerrMessage createPcerrMessage(int fooXyzzy, int barBaz) { return new PcerrMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcerrMessage, 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:
PcerrMessage
- 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 PcerrMessageBuilder()
Construct an empty builder.PcerrMessageBuilder(MessageHeader arg)
Construct a new builder initialized from specifiedMessageHeader
.PcerrMessageBuilder(PcerrMessage base)
Construct a builder initialized with state from specifiedPcerrMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcerrMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PcerrMessage
build()
A newPcerrMessage
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Errors>
getErrors()
Return current value associated with the property corresponding toPcerrMessage.getErrors()
.ErrorType
getErrorType()
Return current value associated with the property corresponding toPcerrMessage.getErrorType()
.ProtocolVersion
getVersion()
Return current value associated with the property corresponding toMessageHeader.getVersion()
.PcerrMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>> augmentationType)
Remove an augmentation from this builder's product.PcerrMessageBuilder
setErrors(List<Errors> values)
Set the property corresponding toPcerrMessage.getErrors()
to the specified value.PcerrMessageBuilder
setErrorType(ErrorType value)
Set the property corresponding toPcerrMessage.getErrorType()
to the specified value.PcerrMessageBuilder
setVersion(ProtocolVersion value)
Set the property corresponding toMessageHeader.getVersion()
to the specified value.
-
-
-
Constructor Detail
-
PcerrMessageBuilder
public PcerrMessageBuilder()
Construct an empty builder.
-
PcerrMessageBuilder
public PcerrMessageBuilder(MessageHeader arg)
Construct a new builder initialized from specifiedMessageHeader
.- Parameters:
arg
- MessageHeader from which the builder should be initialized
-
PcerrMessageBuilder
public PcerrMessageBuilder(PcerrMessage base)
Construct a builder initialized with state from specifiedPcerrMessage
.- Parameters:
base
- PcerrMessage 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 ErrorType getErrorType()
Return current value associated with the property corresponding toPcerrMessage.getErrorType()
.- Returns:
- current value
-
getErrors
public List<Errors> getErrors()
Return current value associated with the property corresponding toPcerrMessage.getErrors()
.- Returns:
- current value
-
getVersion
public ProtocolVersion getVersion()
Return current value associated with the property corresponding toMessageHeader.getVersion()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>> 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 PcerrMessageBuilder setErrorType(ErrorType value)
Set the property corresponding toPcerrMessage.getErrorType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setErrors
public PcerrMessageBuilder setErrors(List<Errors> values)
Set the property corresponding toPcerrMessage.getErrors()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setVersion
public PcerrMessageBuilder setVersion(ProtocolVersion value)
Set the property corresponding toMessageHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcerrMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage> 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 PcerrMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>> 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 PcerrMessage build()
A newPcerrMessage
instance.- Returns:
- A new
PcerrMessage
instance.
-
-