Class TcpFlagsContainerBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.approved.extensions.rev160802.TcpFlagsContainerBuilder
Class that builds
TcpFlagsContainer
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:
TcpFlagsContainer createTcpFlagsContainer(int fooXyzzy, int barBaz) {
return new TcpFlagsContainerBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of TcpFlagsContainer, 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 specifiedTcpFlagsContainer
. -
Method Summary
Modifier and TypeMethodDescription@NonNull TcpFlagsContainer
build()
A newTcpFlagsContainer
instance.Return current value associated with the property corresponding toTcpFlagsContainer.getTcpFlags()
.setTcpFlags
(TcpFlags value) Set the property corresponding toTcpFlagsContainer.getTcpFlags()
to the specified value.
-
Constructor Details
-
TcpFlagsContainerBuilder
public TcpFlagsContainerBuilder()Construct an empty builder. -
TcpFlagsContainerBuilder
Construct a builder initialized with state from specifiedTcpFlagsContainer
.- Parameters:
base
- TcpFlagsContainer from which the builder should be initialized
-
-
Method Details
-
getTcpFlags
Return current value associated with the property corresponding toTcpFlagsContainer.getTcpFlags()
.- Returns:
- current value
-
setTcpFlags
Set the property corresponding toTcpFlagsContainer.getTcpFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newTcpFlagsContainer
instance.- Returns:
- A new
TcpFlagsContainer
instance.
-