Class SupportedInstructionsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SupportedInstructionsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SupportedInstructions>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SupportedInstructions,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SupportedInstructionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SupportedInstructions>
Class that buildsSupportedInstructionsBuilder
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:
SupportedInstructionsBuilder createTarget(int fooXyzzy, int barBaz) { return new SupportedInstructionsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SupportedInstructionsBuilder, 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:
SupportedInstructionsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SupportedInstructionsBuilder()
SupportedInstructionsBuilder(SupportedInstructions base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
SupportedInstructions
build()
Map<InstructionTypeKey,InstructionType>
getInstructionType()
SupportedInstructionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions>> augmentationType)
Remove an augmentation from this builder's product.SupportedInstructionsBuilder
setInstructionType(List<InstructionType> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInstructionType(Map)
instead.SupportedInstructionsBuilder
setInstructionType(Map<InstructionTypeKey,InstructionType> values)
-
-
-
Constructor Detail
-
SupportedInstructionsBuilder
public SupportedInstructionsBuilder()
-
SupportedInstructionsBuilder
public SupportedInstructionsBuilder(SupportedInstructions base)
-
-
Method Detail
-
getInstructionType
public Map<InstructionTypeKey,InstructionType> getInstructionType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedInstructions>> E$$ augmentation(Class<E$$> augmentationType)
-
setInstructionType
public SupportedInstructionsBuilder setInstructionType(Map<InstructionTypeKey,InstructionType> values)
-
setInstructionType
@Deprecated(forRemoval=true) public SupportedInstructionsBuilder setInstructionType(List<InstructionType> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInstructionType(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
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 SupportedInstructions build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SupportedInstructions>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SupportedInstructions,IllegalArgumentException>
-
-