Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.drop.action._case
Class DropActionBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.drop.action._case.DropActionBuilder
Class that builds
DropAction
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:
DropAction createDropAction(int fooXyzzy, int barBaz) {
return new DropActionBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of DropAction, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.DropActionBuilder
(DropAction base) Construct a builder initialized with state from specifiedDropAction
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<DropAction> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DropAction>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull DropAction
build()
A newDropAction
instance.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DropAction>> augmentationType) Remove an augmentation from this builder's product.
-
Constructor Details
-
DropActionBuilder
public DropActionBuilder()Construct an empty builder. -
DropActionBuilder
Construct a builder initialized with state from specifiedDropAction
.- Parameters:
base
- DropAction from which the builder should be initialized
-
-
Method Details
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DropAction>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
addAugmentation
public DropActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DropAction> 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 DropActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DropAction>> 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
A newDropAction
instance.- Returns:
- A new
DropAction
instance.
-