Class InstructionContainerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.InstructionContainerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InstructionContainer>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InstructionContainer,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InstructionContainerBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InstructionContainer>
Class that buildsInstructionContainerBuilder
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:
InstructionContainerBuilder createTarget(int fooXyzzy, int barBaz) { return new InstructionContainerBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InstructionContainerBuilder, 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:
InstructionContainerBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InstructionContainerBuilder()
InstructionContainerBuilder(InstructionContainer base)
InstructionContainerBuilder(InstructionGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InstructionContainerBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer>>
E$$augmentation(Class<E$$> augmentationType)
InstructionContainer
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.InstructionChoice
getInstructionChoice()
InstructionContainerBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer>> augmentationType)
InstructionContainerBuilder
setInstructionChoice(InstructionChoice value)
-
-
-
Constructor Detail
-
InstructionContainerBuilder
public InstructionContainerBuilder()
-
InstructionContainerBuilder
public InstructionContainerBuilder(InstructionGrouping arg)
-
InstructionContainerBuilder
public InstructionContainerBuilder(InstructionContainer 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.openflow.common.instruction.rev130731.InstructionGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getInstructionChoice
public InstructionChoice getInstructionChoice()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer>> E$$ augmentation(Class<E$$> augmentationType)
-
setInstructionChoice
public InstructionContainerBuilder setInstructionChoice(InstructionChoice value)
-
addAugmentation
public InstructionContainerBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer> augmentationValue)
-
removeAugmentation
public InstructionContainerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstructionContainer>> augmentationType)
-
build
public InstructionContainer build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InstructionContainer>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InstructionContainer,IllegalArgumentException>
-
-