Class SetTpDstActionBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.tp.dst.action._case.SetTpDstActionBuilder
Class that builds
SetTpDstAction
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:
SetTpDstAction createSetTpDstAction(int fooXyzzy, int barBaz) {
return new SetTpDstActionBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SetTpDstAction, 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.Construct a builder initialized with state from specifiedSetTpDstAction
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SetTpDstAction> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetTpDstAction>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SetTpDstAction
build()
A newSetTpDstAction
instance.static @NonNull SetTpDstAction
empty()
Get empty instance of SetTpDstAction.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toSetTpDstAction.getIpProtocol()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getPort()
Return current value associated with the property corresponding toSetTpDstAction.getPort()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetTpDstAction>> augmentationType) Remove an augmentation from this builder's product.setIpProtocol
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toSetTpDstAction.getIpProtocol()
to the specified value.setPort
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toSetTpDstAction.getPort()
to the specified value.
-
Constructor Details
-
SetTpDstActionBuilder
public SetTpDstActionBuilder()Construct an empty builder. -
SetTpDstActionBuilder
Construct a builder initialized with state from specifiedSetTpDstAction
.- Parameters:
base
- SetTpDstAction from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of SetTpDstAction.- Returns:
- An empty
SetTpDstAction
-
getIpProtocol
public org.opendaylight.yangtools.yang.common.Uint8 getIpProtocol()Return current value associated with the property corresponding toSetTpDstAction.getIpProtocol()
.- Returns:
- current value
-
getPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()Return current value associated with the property corresponding toSetTpDstAction.getPort()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetTpDstAction>> 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
-
setIpProtocol
Set the property corresponding toSetTpDstAction.getIpProtocol()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPort
public SetTpDstActionBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toSetTpDstAction.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetTpDstActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetTpDstAction> 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 SetTpDstActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetTpDstAction>> 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 newSetTpDstAction
instance.- Returns:
- A new
SetTpDstAction
instance.
-