Class RateQueuePropertyBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.RateQueuePropertyBuilder
Class that builds
RateQueueProperty
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:
RateQueueProperty createRateQueueProperty(int fooXyzzy, int barBaz) {
return new RateQueuePropertyBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RateQueueProperty, 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 specifiedRateQueueProperty
. -
Method Summary
Modifier and TypeMethodDescription@NonNull RateQueueProperty
build()
A newRateQueueProperty
instance.org.opendaylight.yangtools.yang.common.Uint16
getRate()
Return current value associated with the property corresponding toRateQueueProperty.getRate()
.setRate
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toRateQueueProperty.getRate()
to the specified value.
-
Constructor Details
-
RateQueuePropertyBuilder
public RateQueuePropertyBuilder()Construct an empty builder. -
RateQueuePropertyBuilder
Construct a builder initialized with state from specifiedRateQueueProperty
.- Parameters:
base
- RateQueueProperty from which the builder should be initialized
-
-
Method Details
-
getRate
public org.opendaylight.yangtools.yang.common.Uint16 getRate()Return current value associated with the property corresponding toRateQueueProperty.getRate()
.- Returns:
- current value
-
setRate
Set the property corresponding toRateQueueProperty.getRate()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newRateQueueProperty
instance.- Returns:
- A new
RateQueueProperty
instance.
-