Class AggregateTimerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.nsap.unicast.bgp.AggregateTimerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AggregateTimer>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AggregateTimer,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AggregateTimerBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AggregateTimer>
Class that buildsAggregateTimerBuilder
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:
AggregateTimerBuilder createTarget(int fooXyzzy, int barBaz) { return new AggregateTimerBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AggregateTimerBuilder, 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 oportunities, 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:
AggregateTimerBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AggregateTimerBuilder()
AggregateTimerBuilder(AggregateTimer base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AggregateTimerBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AggregateTimer> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateTimer>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AggregateTimer
build()
java.lang.Boolean
getEnable()
org.opendaylight.yangtools.yang.common.Uint16
getThreshold()
java.lang.Boolean
isEnable()
Deprecated, for removal: This API element is subject to removal in a future version.AggregateTimerBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateTimer>> augmentationType)
Remove an augmentation from this builder's product.AggregateTimerBuilder
setEnable(java.lang.Boolean value)
AggregateTimerBuilder
setThreshold(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetThreshold(Uint16)
instead.AggregateTimerBuilder
setThreshold(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
AggregateTimerBuilder
public AggregateTimerBuilder()
-
AggregateTimerBuilder
public AggregateTimerBuilder(AggregateTimer base)
-
-
Method Detail
-
getEnable
public java.lang.Boolean getEnable()
-
isEnable
@Deprecated(forRemoval=true) public final java.lang.Boolean isEnable()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getThreshold
public org.opendaylight.yangtools.yang.common.Uint16 getThreshold()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateTimer>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEnable
public AggregateTimerBuilder setEnable(java.lang.Boolean value)
-
setThreshold
public AggregateTimerBuilder setThreshold(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setThreshold
@Deprecated(forRemoval=true) public AggregateTimerBuilder setThreshold(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetThreshold(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public AggregateTimerBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AggregateTimer> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public AggregateTimerBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AggregateTimer>> 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 AggregateTimer build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AggregateTimer>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AggregateTimer,java.lang.IllegalArgumentException>
-
-