Class CloseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.CloseBuilder
Class that builds
Close
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:
Close createClose(int fooXyzzy, int barBaz) {
return new CloseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Close, 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.CloseBuilder
(Close base) Construct a builder initialized with state from specifiedClose
.CloseBuilder
(CloseMessage arg) Construct a new builder initialized from specifiedCloseMessage
.CloseBuilder
(Message arg) Construct a new builder initialized from specifiedMessage
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Close> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Close>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Close
build()
A newClose
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toCloseMessage.getCCloseMessage()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Close>> augmentationType) Remove an augmentation from this builder's product.setCCloseMessage
(CCloseMessage value) Set the property corresponding toCloseMessage.getCCloseMessage()
to the specified value.
-
Constructor Details
-
CloseBuilder
public CloseBuilder()Construct an empty builder. -
CloseBuilder
Construct a new builder initialized from specifiedCloseMessage
.- Parameters:
arg
- CloseMessage from which the builder should be initialized
-
CloseBuilder
Construct a new builder initialized from specifiedMessage
.- Parameters:
arg
- Message from which the builder should be initialized
-
CloseBuilder
Construct a builder initialized with state from specifiedClose
.- Parameters:
base
- Close 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
-
getCCloseMessage
Return current value associated with the property corresponding toCloseMessage.getCCloseMessage()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Close>> 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
-
setCCloseMessage
Set the property corresponding toCloseMessage.getCCloseMessage()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CloseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Close> 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 CloseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Close>> 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 newClose
instance.- Returns:
- A new
Close
instance.
-