Class SetQueueActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.queue.action._case.SetQueueActionBuilder
-
@Generated("mdsal-binding-generator") public class SetQueueActionBuilder extends Object
Class that buildsSetQueueAction
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:
SetQueueAction createSetQueueAction(int fooXyzzy, int barBaz) { return new SetQueueActionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetQueueAction, 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:
SetQueueAction
- 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 SetQueueActionBuilder()
Construct an empty builder.SetQueueActionBuilder(SetQueueAction base)
Construct a builder initialized with state from specifiedSetQueueAction
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetQueueActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetQueueAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetQueueAction>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SetQueueAction
build()
A newSetQueueAction
instance.String
getQueue()
Return current value associated with the property corresponding toSetQueueAction.getQueue()
.org.opendaylight.yangtools.yang.common.Uint32
getQueueId()
Return current value associated with the property corresponding toSetQueueAction.getQueueId()
.SetQueueActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetQueueAction>> augmentationType)
Remove an augmentation from this builder's product.SetQueueActionBuilder
setQueue(String value)
Set the property corresponding toSetQueueAction.getQueue()
to the specified value.SetQueueActionBuilder
setQueueId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSetQueueAction.getQueueId()
to the specified value.
-
-
-
Constructor Detail
-
SetQueueActionBuilder
public SetQueueActionBuilder()
Construct an empty builder.
-
SetQueueActionBuilder
public SetQueueActionBuilder(SetQueueAction base)
Construct a builder initialized with state from specifiedSetQueueAction
.- Parameters:
base
- SetQueueAction from which the builder should be initialized
-
-
Method Detail
-
getQueue
public String getQueue()
Return current value associated with the property corresponding toSetQueueAction.getQueue()
.- Returns:
- current value
-
getQueueId
public org.opendaylight.yangtools.yang.common.Uint32 getQueueId()
Return current value associated with the property corresponding toSetQueueAction.getQueueId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetQueueAction>> 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
-
setQueue
public SetQueueActionBuilder setQueue(String value)
Set the property corresponding toSetQueueAction.getQueue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setQueueId
public SetQueueActionBuilder setQueueId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSetQueueAction.getQueueId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetQueueActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetQueueAction> 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 SetQueueActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetQueueAction>> 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 SetQueueAction build()
A newSetQueueAction
instance.- Returns:
- A new
SetQueueAction
instance.
-
-