Class InstructionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.instruction.queue.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(Instruction base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
Instruction
build()
Nanotime
getDeadline()
InstructionId
getId()
InstructionStatus
getStatus()
InstructionKey
key()
InstructionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType)
Remove an augmentation from this builder's product.InstructionBuilder
setDeadline(Nanotime value)
InstructionBuilder
setId(InstructionId value)
InstructionBuilder
setStatus(InstructionStatus value)
InstructionBuilder
withKey(InstructionKey key)
-
-
-
Constructor Detail
-
InstructionBuilder
public InstructionBuilder()
-
InstructionBuilder
public InstructionBuilder(Instruction base)
-
-
Method Detail
-
key
public InstructionKey key()
-
getDeadline
public Nanotime getDeadline()
-
getId
public InstructionId getId()
-
getStatus
public InstructionStatus getStatus()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public InstructionBuilder withKey(InstructionKey key)
-
setDeadline
public InstructionBuilder setDeadline(Nanotime value)
-
setId
public InstructionBuilder setId(InstructionId value)
-
setStatus
public InstructionBuilder setStatus(InstructionStatus value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public InstructionBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instruction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Instruction> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 Instruction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Instruction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Instruction,IllegalArgumentException>
-
-