Class SendBarrierOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierOutputBuilder
-
@Generated("mdsal-binding-generator") public class SendBarrierOutputBuilder extends Object
Class that buildsSendBarrierOutput
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:
SendBarrierOutput createSendBarrierOutput(int fooXyzzy, int barBaz) { return new SendBarrierOutputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SendBarrierOutput, 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:
SendBarrierOutput
- 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 SendBarrierOutputBuilder()
Construct an empty builder.SendBarrierOutputBuilder(SendBarrierOutput base)
Construct a builder initialized with state from specifiedSendBarrierOutput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SendBarrierOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SendBarrierOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SendBarrierOutput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SendBarrierOutput
build()
A newSendBarrierOutput
instance.SendBarrierOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SendBarrierOutput>> augmentationType)
Remove an augmentation from this builder's product.
-
-
-
Constructor Detail
-
SendBarrierOutputBuilder
public SendBarrierOutputBuilder()
Construct an empty builder.
-
SendBarrierOutputBuilder
public SendBarrierOutputBuilder(SendBarrierOutput base)
Construct a builder initialized with state from specifiedSendBarrierOutput
.- Parameters:
base
- SendBarrierOutput from which the builder should be initialized
-
-
Method Detail
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SendBarrierOutput>> 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
-
addAugmentation
public SendBarrierOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SendBarrierOutput> 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 SendBarrierOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SendBarrierOutput>> 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 SendBarrierOutput build()
A newSendBarrierOutput
instance.- Returns:
- A new
SendBarrierOutput
instance.
-
-