Class SalAddMessageDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.send.experimenter.input.experimenter.message.of.choice.bundle.add.message.sal.SalAddMessageDataBuilder
-
@Generated("mdsal-binding-generator") public class SalAddMessageDataBuilder extends Object
Class that buildsSalAddMessageData
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:
SalAddMessageData createSalAddMessageData(int fooXyzzy, int barBaz) { return new SalAddMessageDataBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SalAddMessageData, 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:
SalAddMessageData
- 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 SalAddMessageDataBuilder()
Construct an empty builder.SalAddMessageDataBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.SalAddMessageDataBuilder(BundleInnerMessageGrouping arg)
Construct a new builder initialized from specifiedBundleInnerMessageGrouping
.SalAddMessageDataBuilder(SalAddMessageData base)
Construct a builder initialized with state from specifiedSalAddMessageData
.SalAddMessageDataBuilder(BundleCommonGrouping arg)
Construct a new builder initialized from specifiedBundleCommonGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SalAddMessageDataBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SalAddMessageData> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SalAddMessageData>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SalAddMessageData
build()
A newSalAddMessageData
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BundleId
getBundleId()
Return current value associated with the property corresponding toBundleCommonGrouping.getBundleId()
.BundleInnerMessage
getBundleInnerMessage()
Return current value associated with the property corresponding toBundleInnerMessageGrouping.getBundleInnerMessage()
.List<BundleProperty>
getBundleProperty()
Return current value associated with the property corresponding toBundleCommonGrouping.getBundleProperty()
.BundleFlags
getFlags()
Return current value associated with the property corresponding toBundleCommonGrouping.getFlags()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.SalAddMessageDataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SalAddMessageData>> augmentationType)
Remove an augmentation from this builder's product.SalAddMessageDataBuilder
setBundleId(BundleId value)
Set the property corresponding toBundleCommonGrouping.getBundleId()
to the specified value.SalAddMessageDataBuilder
setBundleInnerMessage(BundleInnerMessage value)
Set the property corresponding toBundleInnerMessageGrouping.getBundleInnerMessage()
to the specified value.SalAddMessageDataBuilder
setBundleProperty(List<BundleProperty> values)
Set the property corresponding toBundleCommonGrouping.getBundleProperty()
to the specified value.SalAddMessageDataBuilder
setFlags(BundleFlags value)
Set the property corresponding toBundleCommonGrouping.getFlags()
to the specified value.SalAddMessageDataBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.
-
-
-
Constructor Detail
-
SalAddMessageDataBuilder
public SalAddMessageDataBuilder()
Construct an empty builder.
-
SalAddMessageDataBuilder
public SalAddMessageDataBuilder(BundleCommonGrouping arg)
Construct a new builder initialized from specifiedBundleCommonGrouping
.- Parameters:
arg
- BundleCommonGrouping from which the builder should be initialized
-
SalAddMessageDataBuilder
public SalAddMessageDataBuilder(BundleInnerMessageGrouping arg)
Construct a new builder initialized from specifiedBundleInnerMessageGrouping
.- Parameters:
arg
- BundleInnerMessageGrouping from which the builder should be initialized
-
SalAddMessageDataBuilder
public SalAddMessageDataBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
SalAddMessageDataBuilder
public SalAddMessageDataBuilder(SalAddMessageData base)
Construct a builder initialized with state from specifiedSalAddMessageData
.- Parameters:
base
- SalAddMessageData 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
-
getBundleId
public BundleId getBundleId()
Return current value associated with the property corresponding toBundleCommonGrouping.getBundleId()
.- Returns:
- current value
-
getBundleInnerMessage
public BundleInnerMessage getBundleInnerMessage()
Return current value associated with the property corresponding toBundleInnerMessageGrouping.getBundleInnerMessage()
.- Returns:
- current value
-
getBundleProperty
public List<BundleProperty> getBundleProperty()
Return current value associated with the property corresponding toBundleCommonGrouping.getBundleProperty()
.- Returns:
- current value
-
getFlags
public BundleFlags getFlags()
Return current value associated with the property corresponding toBundleCommonGrouping.getFlags()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SalAddMessageData>> 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
-
setBundleId
public SalAddMessageDataBuilder setBundleId(BundleId value)
Set the property corresponding toBundleCommonGrouping.getBundleId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBundleInnerMessage
public SalAddMessageDataBuilder setBundleInnerMessage(BundleInnerMessage value)
Set the property corresponding toBundleInnerMessageGrouping.getBundleInnerMessage()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBundleProperty
public SalAddMessageDataBuilder setBundleProperty(List<BundleProperty> values)
Set the property corresponding toBundleCommonGrouping.getBundleProperty()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setFlags
public SalAddMessageDataBuilder setFlags(BundleFlags value)
Set the property corresponding toBundleCommonGrouping.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public SalAddMessageDataBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SalAddMessageDataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SalAddMessageData> 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 SalAddMessageDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SalAddMessageData>> 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 SalAddMessageData build()
A newSalAddMessageData
instance.- Returns:
- A new
SalAddMessageData
instance.
-
-