Class InstructionTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.instructions.InstructionTypeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InstructionType>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InstructionType,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InstructionTypeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InstructionType>
Class that buildsInstructionTypeBuilder
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:
InstructionTypeBuilder createTarget(int fooXyzzy, int barBaz) { return new InstructionTypeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InstructionTypeBuilder, 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:
InstructionTypeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InstructionTypeBuilder()
InstructionTypeBuilder(Feature arg)
InstructionTypeBuilder(InstructionType base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InstructionTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InstructionType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionType>>
E$$augmentation(Class<E$$> augmentationType)
InstructionType
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getInstruction()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType
getSupportState()
InstructionTypeKey
key()
InstructionTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionType>> augmentationType)
Remove an augmentation from this builder's product.InstructionTypeBuilder
setInstruction(String value)
InstructionTypeBuilder
setSupportState(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType value)
InstructionTypeBuilder
withKey(InstructionTypeKey key)
-
-
-
Constructor Detail
-
InstructionTypeBuilder
public InstructionTypeBuilder()
-
InstructionTypeBuilder
public InstructionTypeBuilder(Feature arg)
-
InstructionTypeBuilder
public InstructionTypeBuilder(InstructionType 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.flow.inventory.rev130819.Feature
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public InstructionTypeKey key()
-
getInstruction
public String getInstruction()
-
getSupportState
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType getSupportState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionType>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public InstructionTypeBuilder withKey(InstructionTypeKey key)
-
setInstruction
public InstructionTypeBuilder setInstruction(String value)
-
setSupportState
public InstructionTypeBuilder setSupportState(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType value)
-
addAugmentation
public InstructionTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InstructionType> 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 InstructionTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionType>> 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 InstructionType build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InstructionType>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InstructionType,IllegalArgumentException>
-
-