Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.message
Class OpenMessageBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.message.OpenMessageBuilder
Class that builds
OpenMessage
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:
OpenMessage createOpenMessage(int fooXyzzy, int barBaz) {
return new OpenMessageBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of OpenMessage, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedMessageHeader
.Construct a builder initialized with state from specifiedOpenMessage
.Construct a new builder initialized from specifiedOpenObject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull OpenMessage
build()
A newOpenMessage
instance.static @NonNull OpenMessage
empty()
Get empty instance of OpenMessage.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getOpen()
Return current value associated with the property corresponding toOpenObject.getOpen()
.Return current value associated with the property corresponding toMessageHeader.getVersion()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toOpenObject.getOpen()
to the specified value.setVersion
(ProtocolVersion value) Set the property corresponding toMessageHeader.getVersion()
to the specified value.
-
Constructor Details
-
OpenMessageBuilder
public OpenMessageBuilder()Construct an empty builder. -
OpenMessageBuilder
Construct a new builder initialized from specifiedMessageHeader
.- Parameters:
arg
- MessageHeader from which the builder should be initialized
-
OpenMessageBuilder
Construct a new builder initialized from specifiedOpenObject
.- Parameters:
arg
- OpenObject from which the builder should be initialized
-
OpenMessageBuilder
Construct a builder initialized with state from specifiedOpenMessage
.- Parameters:
base
- OpenMessage from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of OpenMessage.- Returns:
- An empty
OpenMessage
-
getOpen
Return current value associated with the property corresponding toOpenObject.getOpen()
.- Returns:
- current value
-
getVersion
Return current value associated with the property corresponding toMessageHeader.getVersion()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>> 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
-
setOpen
Set the property corresponding toOpenObject.getOpen()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
Set the property corresponding toMessageHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OpenMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage> 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 OpenMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>> 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
A newOpenMessage
instance.- Returns:
- A new
OpenMessage
instance.
-