Class OutputActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.output.action._case.OutputActionBuilder
-
@Generated("mdsal-binding-generator") public class OutputActionBuilder extends Object
Class that buildsOutputAction
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:
OutputAction createOutputAction(int fooXyzzy, int barBaz) { return new OutputActionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OutputAction, 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 opportunities, 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:
OutputAction
- 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
-
-
Constructor Summary
Constructors Constructor Description OutputActionBuilder()
Construct an empty builder.OutputActionBuilder(OutputAction base)
Construct a builder initialized with state from specifiedOutputAction
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OutputActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull OutputAction
build()
A newOutputAction
instance.org.opendaylight.yangtools.yang.common.Uint16
getMaxLength()
Return current value associated with the property corresponding toOutputAction.getMaxLength()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getOutputNodeConnector()
Return current value associated with the property corresponding toOutputAction.getOutputNodeConnector()
.OutputActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> augmentationType)
Remove an augmentation from this builder's product.OutputActionBuilder
setMaxLength(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOutputAction.getMaxLength()
to the specified value.OutputActionBuilder
setOutputNodeConnector(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toOutputAction.getOutputNodeConnector()
to the specified value.
-
-
-
Constructor Detail
-
OutputActionBuilder
public OutputActionBuilder()
Construct an empty builder.
-
OutputActionBuilder
public OutputActionBuilder(OutputAction base)
Construct a builder initialized with state from specifiedOutputAction
.- Parameters:
base
- OutputAction from which the builder should be initialized
-
-
Method Detail
-
getMaxLength
public org.opendaylight.yangtools.yang.common.Uint16 getMaxLength()
Return current value associated with the property corresponding toOutputAction.getMaxLength()
.- Returns:
- current value
-
getOutputNodeConnector
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getOutputNodeConnector()
Return current value associated with the property corresponding toOutputAction.getOutputNodeConnector()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setMaxLength
public OutputActionBuilder setMaxLength(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOutputAction.getMaxLength()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutputNodeConnector
public OutputActionBuilder setOutputNodeConnector(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toOutputAction.getOutputNodeConnector()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OutputActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction> 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 OutputActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OutputAction>> 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 @NonNull OutputAction build()
A newOutputAction
instance.- Returns:
- A new
OutputAction
instance.
-
-