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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SalControlData>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SalControlData,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SalControlDataBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SalControlData>
Class that buildsSalControlDataBuilder
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:
SalControlDataBuilder createTarget(int fooXyzzy, int barBaz) { return new SalControlDataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SalControlDataBuilder, 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:
SalControlDataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SalControlDataBuilder()
SalControlDataBuilder(SalControlData base)
SalControlDataBuilder(BundleCommonGrouping arg)
SalControlDataBuilder(BundleControlGrouping arg)
-
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)
SalControlData
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BundleId
getBundleId()
List<BundleProperty>
getBundleProperty()
BundleFlags
getFlags()
BundleControlType
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)
SalControlDataBuilder
setBundleProperty(List<BundleProperty> values)
SalControlDataBuilder
setFlags(BundleFlags value)
SalControlDataBuilder
setType(BundleControlType value)
-
-
-
Constructor Detail
-
SalControlDataBuilder
public SalControlDataBuilder()
-
SalControlDataBuilder
public SalControlDataBuilder(BundleControlGrouping arg)
-
SalControlDataBuilder
public SalControlDataBuilder(BundleCommonGrouping arg)
-
SalControlDataBuilder
public SalControlDataBuilder(SalControlData 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.extension.onf.rev170124.BundleCommonGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleControlGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBundleId
public BundleId getBundleId()
-
getBundleProperty
public List<BundleProperty> getBundleProperty()
-
getFlags
public BundleFlags getFlags()
-
getType
public BundleControlType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SalControlData>> E$$ augmentation(Class<E$$> augmentationType)
-
setBundleId
public SalControlDataBuilder setBundleId(BundleId value)
-
setBundleProperty
public SalControlDataBuilder setBundleProperty(List<BundleProperty> values)
-
setFlags
public SalControlDataBuilder setFlags(BundleFlags value)
-
setType
public SalControlDataBuilder setType(BundleControlType value)
-
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 SalControlData build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SalControlData>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SalControlData,IllegalArgumentException>
-
-