Class ExperimenterCoreMessageItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.mp.message.service.rev151020.send.experimenter.mp.request.output.ExperimenterCoreMessageItemBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExperimenterCoreMessageItem>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterCoreMessageItem,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExperimenterCoreMessageItemBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ExperimenterCoreMessageItem>
Class that buildsExperimenterCoreMessageItemBuilder
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:
ExperimenterCoreMessageItemBuilder createTarget(int fooXyzzy, int barBaz) { return new ExperimenterCoreMessageItemBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExperimenterCoreMessageItemBuilder, 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 oportunities, 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:
ExperimenterCoreMessageItemBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExperimenterCoreMessageItemBuilder()
ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessageItem base)
ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessage arg)
-
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)
ExperimenterCoreMessageItem
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExperimenterMessageOfChoice
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)
-
-
-
Constructor Detail
-
ExperimenterCoreMessageItemBuilder
public ExperimenterCoreMessageItemBuilder()
-
ExperimenterCoreMessageItemBuilder
public ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessage arg)
-
ExperimenterCoreMessageItemBuilder
public ExperimenterCoreMessageItemBuilder(ExperimenterCoreMessageItem base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.ExperimenterCoreMessage
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getExperimenterMessageOfChoice
public ExperimenterMessageOfChoice getExperimenterMessageOfChoice()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterCoreMessageItem>> E$$ augmentation(Class<E$$> augmentationType)
-
setExperimenterMessageOfChoice
public ExperimenterCoreMessageItemBuilder setExperimenterMessageOfChoice(ExperimenterMessageOfChoice value)
-
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 ExperimenterCoreMessageItem build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExperimenterCoreMessageItem>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterCoreMessageItem,IllegalArgumentException>
-
-