Class ExperimenterCoreMessageItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.mp.message.service.rev151020.send.experimenter.mp.request.output.ExperimenterCoreMessageItemBuilder
-
@Generated("mdsal-binding-generator") public class ExperimenterCoreMessageItemBuilder extends Object
Class that buildsExperimenterCoreMessageItem
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:
ExperimenterCoreMessageItem createExperimenterCoreMessageItem(int fooXyzzy, int barBaz) { return new ExperimenterCoreMessageItemBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExperimenterCoreMessageItem, 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:
ExperimenterCoreMessageItem
- 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 ExperimenterCoreMessageItemBuilder()
Construct an empty builder.ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessageItem base)
Construct a builder initialized with state from specifiedExperimenterCoreMessageItem
.ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessage arg)
Construct a new builder initialized from specifiedExperimenterCoreMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExperimenterCoreMessageItemBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterCoreMessageItem> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterCoreMessageItem>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ExperimenterCoreMessageItem
build()
A newExperimenterCoreMessageItem
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExperimenterMessageOfChoice
getExperimenterMessageOfChoice()
Return current value associated with the property corresponding toExperimenterCoreMessage.getExperimenterMessageOfChoice()
.ExperimenterCoreMessageItemBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterCoreMessageItem>> augmentationType)
Remove an augmentation from this builder's product.ExperimenterCoreMessageItemBuilder
setExperimenterMessageOfChoice(ExperimenterMessageOfChoice value)
Set the property corresponding toExperimenterCoreMessage.getExperimenterMessageOfChoice()
to the specified value.
-
-
-
Constructor Detail
-
ExperimenterCoreMessageItemBuilder
public ExperimenterCoreMessageItemBuilder()
Construct an empty builder.
-
ExperimenterCoreMessageItemBuilder
public ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessage arg)
Construct a new builder initialized from specifiedExperimenterCoreMessage
.- Parameters:
arg
- ExperimenterCoreMessage from which the builder should be initialized
-
ExperimenterCoreMessageItemBuilder
public ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessageItem base)
Construct a builder initialized with state from specifiedExperimenterCoreMessageItem
.- Parameters:
base
- ExperimenterCoreMessageItem 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
-
getExperimenterMessageOfChoice
public ExperimenterMessageOfChoice getExperimenterMessageOfChoice()
Return current value associated with the property corresponding toExperimenterCoreMessage.getExperimenterMessageOfChoice()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterCoreMessageItem>> 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
-
setExperimenterMessageOfChoice
public ExperimenterCoreMessageItemBuilder setExperimenterMessageOfChoice(ExperimenterMessageOfChoice value)
Set the property corresponding toExperimenterCoreMessage.getExperimenterMessageOfChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ExperimenterCoreMessageItemBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterCoreMessageItem> 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 ExperimenterCoreMessageItemBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterCoreMessageItem>> 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 ExperimenterCoreMessageItem build()
A newExperimenterCoreMessageItem
instance.- Returns:
- A new
ExperimenterCoreMessageItem
instance.
-
-