Class InstructionBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.instruction.queue.InstructionBuilder
Class that builds
Instruction
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:
Instruction createInstruction(int fooXyzzy, int barBaz) {
return new InstructionBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Instruction, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedInstruction
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Instruction> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Instruction
build()
A newInstruction
instance.Return current value associated with the property corresponding toInstruction.getDeadline()
.getId()
Return current value associated with the property corresponding toInstruction.getId()
.Return current value associated with the property corresponding toInstruction.getStatus()
.key()
Return current value associated with the property corresponding toInstruction.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType) Remove an augmentation from this builder's product.setDeadline
(Nanotime value) Set the property corresponding toInstruction.getDeadline()
to the specified value.setId
(InstructionId value) Set the property corresponding toInstruction.getId()
to the specified value.setStatus
(InstructionStatus value) Set the property corresponding toInstruction.getStatus()
to the specified value.withKey
(InstructionKey key) Set the key value corresponding toInstruction.key()
to the specified value.
-
Constructor Details
-
InstructionBuilder
public InstructionBuilder()Construct an empty builder. -
InstructionBuilder
Construct a builder initialized with state from specifiedInstruction
.- Parameters:
base
- Instruction from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toInstruction.key()
.- Returns:
- current value
-
getDeadline
Return current value associated with the property corresponding toInstruction.getDeadline()
.- Returns:
- current value
-
getId
Return current value associated with the property corresponding toInstruction.getId()
.- Returns:
- current value
-
getStatus
Return current value associated with the property corresponding toInstruction.getStatus()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> 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
Set the key value corresponding toInstruction.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setDeadline
Set the property corresponding toInstruction.getDeadline()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setId
Set the property corresponding toInstruction.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStatus
Set the property corresponding toInstruction.getStatus()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public InstructionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Instruction> 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 InstructionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> 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
A newInstruction
instance.- Returns:
- A new
Instruction
instance.
-