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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PcerrMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PcerrMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PcerrMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PcerrMessage>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description PcerrMessageBuilder()
PcerrMessageBuilder(MessageHeader arg)
PcerrMessageBuilder(PcerrMessage base)
-
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)
PcerrMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Errors>
getErrors()
ErrorType
getErrorType()
ProtocolVersion
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)
PcerrMessageBuilder
setErrorType(ErrorType value)
PcerrMessageBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
PcerrMessageBuilder
public PcerrMessageBuilder()
-
PcerrMessageBuilder
public PcerrMessageBuilder(MessageHeader arg)
-
PcerrMessageBuilder
public PcerrMessageBuilder(PcerrMessage 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:- MessageHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getErrorType
public ErrorType getErrorType()
-
getVersion
public ProtocolVersion getVersion()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcerrMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setErrorType
public PcerrMessageBuilder setErrorType(ErrorType value)
-
setErrors
public PcerrMessageBuilder setErrors(List<Errors> values)
-
setVersion
public PcerrMessageBuilder setVersion(ProtocolVersion value)
-
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 PcerrMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PcerrMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PcerrMessage,IllegalArgumentException>
-
-