Class SalControlDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.send.experimenter.input.experimenter.message.of.choice.bundle.control.sal.SalControlDataBuilder
-
@Generated("mdsal-binding-generator") public class SalControlDataBuilder extends Object
Class that buildsSalControlData
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:
SalControlData createSalControlData(int fooXyzzy, int barBaz) { return new SalControlDataBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SalControlData, 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:
SalControlData
- 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 SalControlDataBuilder()
Construct an empty builder.SalControlDataBuilder(SalControlData base)
Construct a builder initialized with state from specifiedSalControlData
.SalControlDataBuilder(BundleCommonGrouping arg)
Construct a new builder initialized from specifiedBundleCommonGrouping
.SalControlDataBuilder(BundleControlGrouping arg)
Construct a new builder initialized from specifiedBundleControlGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SalControlDataBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SalControlData> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SalControlData>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SalControlData
build()
A newSalControlData
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()
.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()
.BundleControlType
getType()
Return current value associated with the property corresponding toBundleControlGrouping.getType()
.SalControlDataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SalControlData>> augmentationType)
Remove an augmentation from this builder's product.SalControlDataBuilder
setBundleId(BundleId value)
Set the property corresponding toBundleCommonGrouping.getBundleId()
to the specified value.SalControlDataBuilder
setBundleProperty(List<BundleProperty> values)
Set the property corresponding toBundleCommonGrouping.getBundleProperty()
to the specified value.SalControlDataBuilder
setFlags(BundleFlags value)
Set the property corresponding toBundleCommonGrouping.getFlags()
to the specified value.SalControlDataBuilder
setType(BundleControlType value)
Set the property corresponding toBundleControlGrouping.getType()
to the specified value.
-
-
-
Constructor Detail
-
SalControlDataBuilder
public SalControlDataBuilder()
Construct an empty builder.
-
SalControlDataBuilder
public SalControlDataBuilder(BundleControlGrouping arg)
Construct a new builder initialized from specifiedBundleControlGrouping
.- Parameters:
arg
- BundleControlGrouping from which the builder should be initialized
-
SalControlDataBuilder
public SalControlDataBuilder(BundleCommonGrouping arg)
Construct a new builder initialized from specifiedBundleCommonGrouping
.- Parameters:
arg
- BundleCommonGrouping from which the builder should be initialized
-
SalControlDataBuilder
public SalControlDataBuilder(SalControlData base)
Construct a builder initialized with state from specifiedSalControlData
.- Parameters:
base
- SalControlData 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
-
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
-
getType
public BundleControlType getType()
Return current value associated with the property corresponding toBundleControlGrouping.getType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SalControlData>> 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 SalControlDataBuilder setBundleId(BundleId value)
Set the property corresponding toBundleCommonGrouping.getBundleId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBundleProperty
public SalControlDataBuilder setBundleProperty(List<BundleProperty> values)
Set the property corresponding toBundleCommonGrouping.getBundleProperty()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setFlags
public SalControlDataBuilder setFlags(BundleFlags value)
Set the property corresponding toBundleCommonGrouping.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
public SalControlDataBuilder setType(BundleControlType value)
Set the property corresponding toBundleControlGrouping.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SalControlDataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SalControlData> 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 SalControlDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SalControlData>> 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 SalControlData build()
A newSalControlData
instance.- Returns:
- A new
SalControlData
instance.
-
-