Class SetNwDstActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.set.nw.dst._case.SetNwDstActionBuilder
-
@Generated("mdsal-binding-generator") public class SetNwDstActionBuilder extends Object
Class that buildsSetNwDstAction
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:
SetNwDstAction createSetNwDstAction(int fooXyzzy, int barBaz) { return new SetNwDstActionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetNwDstAction, 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:
SetNwDstAction
- 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
-
-
Constructor Summary
Constructors Constructor Description SetNwDstActionBuilder()
Construct an empty builder.SetNwDstActionBuilder(SetNwDstAction base)
Construct a builder initialized with state from specifiedSetNwDstAction
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetNwDstActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNwDstAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwDstAction>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SetNwDstAction
build()
A newSetNwDstAction
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
getIpAddress()
Return current value associated with the property corresponding toSetNwDstAction.getIpAddress()
.SetNwDstActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwDstAction>> augmentationType)
Remove an augmentation from this builder's product.SetNwDstActionBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
Set the property corresponding toSetNwDstAction.getIpAddress()
to the specified value.
-
-
-
Constructor Detail
-
SetNwDstActionBuilder
public SetNwDstActionBuilder()
Construct an empty builder.
-
SetNwDstActionBuilder
public SetNwDstActionBuilder(SetNwDstAction base)
Construct a builder initialized with state from specifiedSetNwDstAction
.- Parameters:
base
- SetNwDstAction from which the builder should be initialized
-
-
Method Detail
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpAddress()
Return current value associated with the property corresponding toSetNwDstAction.getIpAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwDstAction>> 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
-
setIpAddress
public SetNwDstActionBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
Set the property corresponding toSetNwDstAction.getIpAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetNwDstActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNwDstAction> 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 SetNwDstActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwDstAction>> 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 @NonNull SetNwDstAction build()
A newSetNwDstAction
instance.- Returns:
- A new
SetNwDstAction
instance.
-
-