Class ResultBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.output.ResultBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Result>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Result,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ResultBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Result>
Class that buildsResult
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:
Result createResult(int fooXyzzy, int barBaz) { return new ResultBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Result, 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:
Result
,Builder
-
-
Constructor Summary
Constructors Constructor Description ResultBuilder()
ResultBuilder(Result base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ResultBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Result> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Result>>
E$$augmentation(Class<E$$> augmentationType)
Result
build()
org.opendaylight.yangtools.yang.common.Uint32
getCount()
org.opendaylight.yangtools.yang.common.Uint32
getDuration()
org.opendaylight.yangtools.yang.common.Uint32
getRate()
ResultBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Result>> augmentationType)
Remove an augmentation from this builder's product.ResultBuilder
setCount(org.opendaylight.yangtools.yang.common.Uint32 value)
ResultBuilder
setDuration(org.opendaylight.yangtools.yang.common.Uint32 value)
ResultBuilder
setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
ResultBuilder
public ResultBuilder()
-
ResultBuilder
public ResultBuilder(Result base)
-
-
Method Detail
-
getCount
public org.opendaylight.yangtools.yang.common.Uint32 getCount()
-
getDuration
public org.opendaylight.yangtools.yang.common.Uint32 getDuration()
-
getRate
public org.opendaylight.yangtools.yang.common.Uint32 getRate()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Result>> E$$ augmentation(Class<E$$> augmentationType)
-
setCount
public ResultBuilder setCount(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDuration
public ResultBuilder setDuration(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setRate
public ResultBuilder setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public ResultBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Result> 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 ResultBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Result>> 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 Result build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Result>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Result,IllegalArgumentException>
-
-