Class InstructionsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.InstructionsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Instructions>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Instructions,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InstructionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Instructions>
Class that buildsInstructionsBuilder
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:
InstructionsBuilder createTarget(int fooXyzzy, int barBaz) { return new InstructionsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InstructionsBuilder, 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:
InstructionsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InstructionsBuilder()
InstructionsBuilder(Instructions base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InstructionsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Instructions> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Instructions>>
E$$augmentation(Class<E$$> augmentationType)
Instructions
build()
Instructions
getInstructions()
InstructionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instructions>> augmentationType)
Remove an augmentation from this builder's product.InstructionsBuilder
setInstructions(Instructions value)
-
-
-
Constructor Detail
-
InstructionsBuilder
public InstructionsBuilder()
-
InstructionsBuilder
public InstructionsBuilder(Instructions base)
-
-
Method Detail
-
getInstructions
public Instructions getInstructions()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Instructions>> E$$ augmentation(Class<E$$> augmentationType)
-
setInstructions
public InstructionsBuilder setInstructions(Instructions value)
-
addAugmentation
public InstructionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Instructions> 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 InstructionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Instructions>> 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 Instructions build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Instructions>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Instructions,IllegalArgumentException>
-
-