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