Class ExperimenterMessageFromDevBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExperimenterMessageFromDev>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterMessageFromDev,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExperimenterMessageFromDevBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ExperimenterMessageFromDev>
Class that buildsExperimenterMessageFromDevBuilder
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:
ExperimenterMessageFromDevBuilder createTarget(int fooXyzzy, int barBaz) { return new ExperimenterMessageFromDevBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExperimenterMessageFromDevBuilder, 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:
ExperimenterMessageFromDevBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExperimenterMessageFromDevBuilder()
ExperimenterMessageFromDevBuilder(ExperimenterMessageFromDev base)
ExperimenterMessageFromDevBuilder(ExperimenterSymmetricMessage arg)
ExperimenterMessageFromDevBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
ExperimenterMessageFromDevBuilder(ExperimenterCoreMessage arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExperimenterMessageFromDevBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessageFromDev> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessageFromDev>>
E$$augmentation(Class<E$$> augmentationType)
ExperimenterMessageFromDev
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExperimenterMessageOfChoice
getExperimenterMessageOfChoice()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef
getNode()
ExperimenterMessageFromDevBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessageFromDev>> augmentationType)
Remove an augmentation from this builder's product.ExperimenterMessageFromDevBuilder
setExperimenterMessageOfChoice(ExperimenterMessageOfChoice value)
ExperimenterMessageFromDevBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
-
-
Constructor Detail
-
ExperimenterMessageFromDevBuilder
public ExperimenterMessageFromDevBuilder()
-
ExperimenterMessageFromDevBuilder
public ExperimenterMessageFromDevBuilder(ExperimenterSymmetricMessage arg)
-
ExperimenterMessageFromDevBuilder
public ExperimenterMessageFromDevBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
ExperimenterMessageFromDevBuilder
public ExperimenterMessageFromDevBuilder(ExperimenterCoreMessage arg)
-
ExperimenterMessageFromDevBuilder
public ExperimenterMessageFromDevBuilder(ExperimenterMessageFromDev 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.experimenter.message.service.rev151020.ExperimenterSymmetricMessage
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
- 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()
-
getNode
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessageFromDev>> E$$ augmentation(Class<E$$> augmentationType)
-
setExperimenterMessageOfChoice
public ExperimenterMessageFromDevBuilder setExperimenterMessageOfChoice(ExperimenterMessageOfChoice value)
-
setNode
public ExperimenterMessageFromDevBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
addAugmentation
public ExperimenterMessageFromDevBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessageFromDev> 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 ExperimenterMessageFromDevBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessageFromDev>> 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 ExperimenterMessageFromDev build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExperimenterMessageFromDev>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterMessageFromDev,IllegalArgumentException>
-
-