Class EnqueueActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.enqueue._case.EnqueueActionBuilder
-
@Generated("mdsal-binding-generator") public class EnqueueActionBuilder extends Object
Class that buildsEnqueueAction
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:
EnqueueAction createEnqueueAction(int fooXyzzy, int barBaz) { return new EnqueueActionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EnqueueAction, 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:
EnqueueAction
- 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 EnqueueActionBuilder()
Construct an empty builder.EnqueueActionBuilder(EnqueueAction base)
Construct a builder initialized with state from specifiedEnqueueAction
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnqueueActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EnqueueAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EnqueueAction>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull EnqueueAction
build()
A newEnqueueAction
instance.PortNumber
getPort()
Return current value associated with the property corresponding toEnqueueAction.getPort()
.QueueId
getQueueId()
Return current value associated with the property corresponding toEnqueueAction.getQueueId()
.EnqueueActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EnqueueAction>> augmentationType)
Remove an augmentation from this builder's product.EnqueueActionBuilder
setPort(PortNumber value)
Set the property corresponding toEnqueueAction.getPort()
to the specified value.EnqueueActionBuilder
setQueueId(QueueId value)
Set the property corresponding toEnqueueAction.getQueueId()
to the specified value.
-
-
-
Constructor Detail
-
EnqueueActionBuilder
public EnqueueActionBuilder()
Construct an empty builder.
-
EnqueueActionBuilder
public EnqueueActionBuilder(EnqueueAction base)
Construct a builder initialized with state from specifiedEnqueueAction
.- Parameters:
base
- EnqueueAction from which the builder should be initialized
-
-
Method Detail
-
getPort
public PortNumber getPort()
Return current value associated with the property corresponding toEnqueueAction.getPort()
.- Returns:
- current value
-
getQueueId
public QueueId getQueueId()
Return current value associated with the property corresponding toEnqueueAction.getQueueId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EnqueueAction>> 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
-
setPort
public EnqueueActionBuilder setPort(PortNumber value)
Set the property corresponding toEnqueueAction.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setQueueId
public EnqueueActionBuilder setQueueId(QueueId value)
Set the property corresponding toEnqueueAction.getQueueId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EnqueueActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EnqueueAction> 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 EnqueueActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EnqueueAction>> 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 EnqueueAction build()
A newEnqueueAction
instance.- Returns:
- A new
EnqueueAction
instance.
-
-