Class SupportedInstructionsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SupportedInstructionsBuilder
-
@Generated("mdsal-binding-generator") public class SupportedInstructionsBuilder extends Object
Class that buildsSupportedInstructions
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:
SupportedInstructions createSupportedInstructions(int fooXyzzy, int barBaz) { return new SupportedInstructionsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SupportedInstructions, 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:
SupportedInstructions
- 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 SupportedInstructionsBuilder()
Construct an empty builder.SupportedInstructionsBuilder(SupportedInstructions base)
Construct a builder initialized with state from specifiedSupportedInstructions
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SupportedInstructionsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SupportedInstructions
build()
A newSupportedInstructions
instance.Map<InstructionTypeKey,InstructionType>
getInstructionType()
Return current value associated with the property corresponding toSupportedInstructions.getInstructionType()
.SupportedInstructionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions>> augmentationType)
Remove an augmentation from this builder's product.SupportedInstructionsBuilder
setInstructionType(Map<InstructionTypeKey,InstructionType> values)
Set the property corresponding toSupportedInstructions.getInstructionType()
to the specified value.
-
-
-
Constructor Detail
-
SupportedInstructionsBuilder
public SupportedInstructionsBuilder()
Construct an empty builder.
-
SupportedInstructionsBuilder
public SupportedInstructionsBuilder(SupportedInstructions base)
Construct a builder initialized with state from specifiedSupportedInstructions
.- Parameters:
base
- SupportedInstructions from which the builder should be initialized
-
-
Method Detail
-
getInstructionType
public Map<InstructionTypeKey,InstructionType> getInstructionType()
Return current value associated with the property corresponding toSupportedInstructions.getInstructionType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions>> 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
-
setInstructionType
public SupportedInstructionsBuilder setInstructionType(Map<InstructionTypeKey,InstructionType> values)
Set the property corresponding toSupportedInstructions.getInstructionType()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SupportedInstructionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions> 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 SupportedInstructionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions>> 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 SupportedInstructions build()
A newSupportedInstructions
instance.- Returns:
- A new
SupportedInstructions
instance.
-
-