Class OutputActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.output.action._case.OutputActionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OutputAction>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OutputAction,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class OutputActionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OutputAction>
Class that buildsOutputActionBuilder
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:
OutputActionBuilder createTarget(int fooXyzzy, int barBaz) { return new OutputActionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OutputActionBuilder, 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:
OutputActionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OutputActionBuilder()
OutputActionBuilder(OutputAction base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OutputActionBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>>
E$$augmentation(Class<E$$> augmentationType)
OutputAction
build()
org.opendaylight.yangtools.yang.common.Uint16
getMaxLength()
PortNumber
getPort()
OutputActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> augmentationType)
OutputActionBuilder
setMaxLength(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxLength(Uint16)} instead.OutputActionBuilder
setMaxLength(org.opendaylight.yangtools.yang.common.Uint16 value)
OutputActionBuilder
setPort(PortNumber value)
-
-
-
Constructor Detail
-
OutputActionBuilder
public OutputActionBuilder()
-
OutputActionBuilder
public OutputActionBuilder(OutputAction base)
-
-
Method Detail
-
getMaxLength
public org.opendaylight.yangtools.yang.common.Uint16 getMaxLength()
-
getPort
public PortNumber getPort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> E$$ augmentation(Class<E$$> augmentationType)
-
setMaxLength
public OutputActionBuilder setMaxLength(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMaxLength
@Deprecated(forRemoval=true) public OutputActionBuilder setMaxLength(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxLength(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPort
public OutputActionBuilder setPort(PortNumber value)
-
addAugmentation
public OutputActionBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction> augmentationValue)
-
removeAugmentation
public OutputActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> augmentationType)
-
build
public OutputAction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OutputAction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OutputAction,IllegalArgumentException>
-
-