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