Class InstructionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.InstructionBuilder
-
@Generated("mdsal-binding-generator") public class InstructionBuilder extends Object
Class that buildsInstruction
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:
Instruction
- 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 InstructionBuilder()
Construct an empty builder.InstructionBuilder(InstructionGrouping arg)
Construct a new builder initialized from specifiedInstructionGrouping
.InstructionBuilder(Instruction base)
Construct a builder initialized with state from specifiedInstruction
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InstructionBuilder
addAugmentation(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.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExperimenterId
getExperimenterId()
Return current value associated with the property corresponding toInstruction.getExperimenterId()
.InstructionChoice
getInstructionChoice()
Return current value associated with the property corresponding toInstructionGrouping.getInstructionChoice()
.InstructionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType)
Remove an augmentation from this builder's product.InstructionBuilder
setExperimenterId(ExperimenterId value)
Set the property corresponding toInstruction.getExperimenterId()
to the specified value.InstructionBuilder
setInstructionChoice(InstructionChoice value)
Set the property corresponding toInstructionGrouping.getInstructionChoice()
to the specified value.
-
-
-
Constructor Detail
-
InstructionBuilder
public InstructionBuilder()
Construct an empty builder.
-
InstructionBuilder
public InstructionBuilder(InstructionGrouping arg)
Construct a new builder initialized from specifiedInstructionGrouping
.- Parameters:
arg
- InstructionGrouping from which the builder should be initialized
-
InstructionBuilder
public InstructionBuilder(Instruction base)
Construct a builder initialized with state from specifiedInstruction
.- Parameters:
base
- Instruction 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
-
getExperimenterId
public ExperimenterId getExperimenterId()
Return current value associated with the property corresponding toInstruction.getExperimenterId()
.- Returns:
- current value
-
getInstructionChoice
public InstructionChoice getInstructionChoice()
Return current value associated with the property corresponding toInstructionGrouping.getInstructionChoice()
.- 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
-
setExperimenterId
public InstructionBuilder setExperimenterId(ExperimenterId value)
Set the property corresponding toInstruction.getExperimenterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstructionChoice
public InstructionBuilder setInstructionChoice(InstructionChoice value)
Set the property corresponding toInstructionGrouping.getInstructionChoice()
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
public @NonNull Instruction build()
A newInstruction
instance.- Returns:
- A new
Instruction
instance.
-
-