Class InstructionsQueueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionsQueueBuilder
-
@Generated("mdsal-binding-generator") public class InstructionsQueueBuilder extends Object
Class that buildsInstructionsQueue
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:
InstructionsQueue createInstructionsQueue(int fooXyzzy, int barBaz) { return new InstructionsQueueBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InstructionsQueue, 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:
InstructionsQueue
- 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 InstructionsQueueBuilder()
Construct an empty builder.InstructionsQueueBuilder(InstructionQueue arg)
Construct a new builder initialized from specifiedInstructionQueue
.InstructionsQueueBuilder(InstructionsQueue base)
Construct a builder initialized with state from specifiedInstructionsQueue
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InstructionsQueueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InstructionsQueue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionsQueue>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull InstructionsQueue
build()
A newInstructionsQueue
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<InstructionKey,Instruction>
getInstruction()
Return current value associated with the property corresponding toInstructionQueue.getInstruction()
.String
getInstructionQueueId()
Return current value associated with the property corresponding toInstructionQueue.getInstructionQueueId()
.InstructionsQueueKey
key()
Return current value associated with the property corresponding toInstructionsQueue.key()
.InstructionsQueueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionsQueue>> augmentationType)
Remove an augmentation from this builder's product.InstructionsQueueBuilder
setInstruction(Map<InstructionKey,Instruction> values)
Set the property corresponding toInstructionQueue.getInstruction()
to the specified value.InstructionsQueueBuilder
setInstructionQueueId(String value)
Set the property corresponding toInstructionQueue.getInstructionQueueId()
to the specified value.InstructionsQueueBuilder
withKey(InstructionsQueueKey key)
-
-
-
Constructor Detail
-
InstructionsQueueBuilder
public InstructionsQueueBuilder()
Construct an empty builder.
-
InstructionsQueueBuilder
public InstructionsQueueBuilder(InstructionQueue arg)
Construct a new builder initialized from specifiedInstructionQueue
.- Parameters:
arg
- InstructionQueue from which the builder should be initialized
-
InstructionsQueueBuilder
public InstructionsQueueBuilder(InstructionsQueue base)
Construct a builder initialized with state from specifiedInstructionsQueue
.- Parameters:
base
- InstructionsQueue from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public InstructionsQueueKey key()
Return current value associated with the property corresponding toInstructionsQueue.key()
.- Returns:
- current value
-
getInstruction
public Map<InstructionKey,Instruction> getInstruction()
Return current value associated with the property corresponding toInstructionQueue.getInstruction()
.- Returns:
- current value
-
getInstructionQueueId
public String getInstructionQueueId()
Return current value associated with the property corresponding toInstructionQueue.getInstructionQueueId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionsQueue>> 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
-
withKey
public InstructionsQueueBuilder withKey(InstructionsQueueKey key)
-
setInstruction
public InstructionsQueueBuilder setInstruction(Map<InstructionKey,Instruction> values)
Set the property corresponding toInstructionQueue.getInstruction()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setInstructionQueueId
public InstructionsQueueBuilder setInstructionQueueId(String value)
Set the property corresponding toInstructionQueue.getInstructionQueueId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public InstructionsQueueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InstructionsQueue> 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 InstructionsQueueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionsQueue>> 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 InstructionsQueue build()
A newInstructionsQueue
instance.- Returns:
- A new
InstructionsQueue
instance.
-
-