Class ControllerActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.controller.action._case.ControllerActionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ControllerAction>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ControllerAction,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ControllerActionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ControllerAction>
Class that buildsControllerActionBuilder
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:
ControllerActionBuilder createTarget(int fooXyzzy, int barBaz) { return new ControllerActionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ControllerActionBuilder, 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:
ControllerActionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ControllerActionBuilder()
ControllerActionBuilder(ControllerAction base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ControllerActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction>>
E$$augmentation(Class<E$$> augmentationType)
ControllerAction
build()
org.opendaylight.yangtools.yang.common.Uint16
getMaxLength()
ControllerActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction>> augmentationType)
Remove an augmentation from this builder's product.ControllerActionBuilder
setMaxLength(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxLength(Uint16)
instead.ControllerActionBuilder
setMaxLength(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
ControllerActionBuilder
public ControllerActionBuilder()
-
ControllerActionBuilder
public ControllerActionBuilder(ControllerAction base)
-
-
Method Detail
-
getMaxLength
public org.opendaylight.yangtools.yang.common.Uint16 getMaxLength()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction>> E$$ augmentation(Class<E$$> augmentationType)
-
setMaxLength
public ControllerActionBuilder setMaxLength(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMaxLength
@Deprecated(forRemoval=true) public ControllerActionBuilder setMaxLength(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxLength(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public ControllerActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction> 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 ControllerActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction>> 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 ControllerAction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ControllerAction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ControllerAction,IllegalArgumentException>
-
-