Class OnfAddMessageGroupingDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.experimenter.input.experimenter.data.of.choice.bundle.add.message.onf.OnfAddMessageGroupingDataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OnfAddMessageGroupingData>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OnfAddMessageGroupingData,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class OnfAddMessageGroupingDataBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OnfAddMessageGroupingData>
Class that buildsOnfAddMessageGroupingDataBuilder
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:
OnfAddMessageGroupingDataBuilder createTarget(int fooXyzzy, int barBaz) { return new OnfAddMessageGroupingDataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OnfAddMessageGroupingDataBuilder, 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:
OnfAddMessageGroupingDataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OnfAddMessageGroupingDataBuilder()
OnfAddMessageGroupingDataBuilder(BundleAddMessageGrouping arg)
OnfAddMessageGroupingDataBuilder(BundleCommonGrouping arg)
OnfAddMessageGroupingDataBuilder(OnfAddMessageGroupingData base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OnfAddMessageGroupingDataBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.OnfAddMessageGroupingDataBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData>>
E$$augmentation(Class<E$$> augmentationType)
OnfAddMessageGroupingData
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BundleId
getBundleId()
BundleInnerMessage
getBundleInnerMessage()
List<BundleProperty>
getBundleProperty()
BundleFlags
getFlags()
OnfAddMessageGroupingDataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData>> augmentationType)
Remove an augmentation from this builder's product.OnfAddMessageGroupingDataBuilder
setBundleId(BundleId value)
OnfAddMessageGroupingDataBuilder
setBundleInnerMessage(BundleInnerMessage value)
OnfAddMessageGroupingDataBuilder
setBundleProperty(List<BundleProperty> values)
OnfAddMessageGroupingDataBuilder
setFlags(BundleFlags value)
-
-
-
Constructor Detail
-
OnfAddMessageGroupingDataBuilder
public OnfAddMessageGroupingDataBuilder()
-
OnfAddMessageGroupingDataBuilder
public OnfAddMessageGroupingDataBuilder(BundleAddMessageGrouping arg)
-
OnfAddMessageGroupingDataBuilder
public OnfAddMessageGroupingDataBuilder(BundleCommonGrouping arg)
-
OnfAddMessageGroupingDataBuilder
public OnfAddMessageGroupingDataBuilder(OnfAddMessageGroupingData 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.BundleAddMessageGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getBundleId
public BundleId getBundleId()
-
getBundleInnerMessage
public BundleInnerMessage getBundleInnerMessage()
-
getBundleProperty
public List<BundleProperty> getBundleProperty()
-
getFlags
public BundleFlags getFlags()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData>> E$$ augmentation(Class<E$$> augmentationType)
-
setBundleId
public OnfAddMessageGroupingDataBuilder setBundleId(BundleId value)
-
setBundleInnerMessage
public OnfAddMessageGroupingDataBuilder setBundleInnerMessage(BundleInnerMessage value)
-
setBundleProperty
public OnfAddMessageGroupingDataBuilder setBundleProperty(List<BundleProperty> values)
-
setFlags
public OnfAddMessageGroupingDataBuilder setFlags(BundleFlags value)
-
addAugmentation
public OnfAddMessageGroupingDataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public OnfAddMessageGroupingDataBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public OnfAddMessageGroupingDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OnfAddMessageGroupingData>> 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 OnfAddMessageGroupingData build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OnfAddMessageGroupingData>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OnfAddMessageGroupingData,IllegalArgumentException>
-
-