Class InstructionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.InstructionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Instruction>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Instruction,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InstructionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Instruction>
Class that buildsInstructionBuilder
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:
InstructionBuilder createTarget(int fooXyzzy, int barBaz) { return new InstructionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InstructionBuilder, 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 oportunities, 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:
InstructionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InstructionBuilder()
InstructionBuilder(InstructionGrouping arg)
InstructionBuilder(Instruction base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InstructionBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Instruction> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>>
E$$augmentation(Class<E$$> augmentationType)
Instruction
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExperimenterId
getExperimenterId()
InstructionChoice
getInstructionChoice()
InstructionKey
key()
InstructionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType)
InstructionBuilder
setExperimenterId(ExperimenterId value)
InstructionBuilder
setInstructionChoice(InstructionChoice value)
InstructionBuilder
withKey(InstructionKey key)
-
-
-
Constructor Detail
-
InstructionBuilder
public InstructionBuilder()
-
InstructionBuilder
public InstructionBuilder(InstructionGrouping arg)
-
InstructionBuilder
public InstructionBuilder(Instruction base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.InstructionGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public InstructionKey key()
-
getExperimenterId
public ExperimenterId getExperimenterId()
-
getInstructionChoice
public InstructionChoice getInstructionChoice()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public InstructionBuilder withKey(InstructionKey key)
-
setExperimenterId
public InstructionBuilder setExperimenterId(ExperimenterId value)
-
setInstructionChoice
public InstructionBuilder setInstructionChoice(InstructionChoice value)
-
addAugmentation
public InstructionBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Instruction> augmentationValue)
-
removeAugmentation
public InstructionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType)
-
build
public Instruction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Instruction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Instruction,IllegalArgumentException>
-
-