Class WriteActionsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.write.actions.WriteActionsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<WriteActions>
,org.opendaylight.yangtools.concepts.CheckedBuilder<WriteActions,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class WriteActionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<WriteActions>
Class that buildsWriteActionsBuilder
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:
WriteActionsBuilder createTarget(int fooXyzzy, int barBaz) { return new WriteActionsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of WriteActionsBuilder, 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:
WriteActionsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description WriteActionsBuilder()
WriteActionsBuilder(ActionList arg)
WriteActionsBuilder(WriteActions base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description WriteActionsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<WriteActions> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteActions>>
E$$augmentation(Class<E$$> augmentationType)
WriteActions
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<ActionKey,Action>
getAction()
WriteActionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteActions>> augmentationType)
Remove an augmentation from this builder's product.WriteActionsBuilder
setAction(List<Action> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAction(Map)
instead.WriteActionsBuilder
setAction(Map<ActionKey,Action> values)
-
-
-
Constructor Detail
-
WriteActionsBuilder
public WriteActionsBuilder()
-
WriteActionsBuilder
public WriteActionsBuilder(ActionList arg)
-
WriteActionsBuilder
public WriteActionsBuilder(WriteActions 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.action.types.rev131112.ActionList
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteActions>> E$$ augmentation(Class<E$$> augmentationType)
-
setAction
public WriteActionsBuilder setAction(Map<ActionKey,Action> values)
-
setAction
@Deprecated(forRemoval=true) public WriteActionsBuilder setAction(List<Action> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAction(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public WriteActionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<WriteActions> 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 WriteActionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteActions>> 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 WriteActions build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<WriteActions>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<WriteActions,IllegalArgumentException>
-
-