Class OpenBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.OpenBuilder
-
@Generated("mdsal-binding-generator") public class OpenBuilder extends Object
Class that buildsOpen
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:
Open createOpen(int fooXyzzy, int barBaz) { return new OpenBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Open, 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:
Open
- 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 OpenBuilder()
Construct an empty builder.OpenBuilder(Open base)
Construct a builder initialized with state from specifiedOpen
.OpenBuilder(Message arg)
Construct a new builder initialized from specifiedMessage
.OpenBuilder(OpenMessage arg)
Construct a new builder initialized from specifiedOpenMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OpenBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Open> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Open
build()
A newOpen
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.OpenMessage
getOpenMessage()
Return current value associated with the property corresponding toOpenMessage.getOpenMessage()
.OpenBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>> augmentationType)
Remove an augmentation from this builder's product.OpenBuilder
setOpenMessage(OpenMessage value)
Set the property corresponding toOpenMessage.getOpenMessage()
to the specified value.
-
-
-
Constructor Detail
-
OpenBuilder
public OpenBuilder()
Construct an empty builder.
-
OpenBuilder
public OpenBuilder(OpenMessage arg)
Construct a new builder initialized from specifiedOpenMessage
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.OpenMessage from which the builder should be initialized
-
OpenBuilder
public OpenBuilder(Message arg)
Construct a new builder initialized from specifiedMessage
.- Parameters:
arg
- Message 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
-
getOpenMessage
public OpenMessage getOpenMessage()
Return current value associated with the property corresponding toOpenMessage.getOpenMessage()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>> 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
-
setOpenMessage
public OpenBuilder setOpenMessage(OpenMessage value)
Set the property corresponding toOpenMessage.getOpenMessage()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OpenBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Open> 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 OpenBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>> 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
-
-