Class DetectionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.slow.peer.config.DetectionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Detection>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Detection,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DetectionBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Detection>
Class that buildsDetectionBuilder
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:
DetectionBuilder createTarget(int fooXyzzy, int barBaz) { return new DetectionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DetectionBuilder, 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:
DetectionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DetectionBuilder()
DetectionBuilder(Detection base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DetectionBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Detection>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Detection> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DetectionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Detection> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Detection>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Detection
build()
org.opendaylight.yangtools.yang.common.Uint16
getThreshold()
java.lang.Boolean
isEnable()
DetectionBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Detection>> augmentationType)
Remove an augmentation from this builder's product.DetectionBuilder
setEnable(java.lang.Boolean value)
DetectionBuilder
setThreshold(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetThreshold(Uint16)
instead.DetectionBuilder
setThreshold(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
DetectionBuilder
public DetectionBuilder()
-
DetectionBuilder
public DetectionBuilder(Detection base)
-
-
Method Detail
-
getThreshold
public org.opendaylight.yangtools.yang.common.Uint16 getThreshold()
-
isEnable
public java.lang.Boolean isEnable()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Detection>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setThreshold
public DetectionBuilder setThreshold(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setThreshold
@Deprecated(forRemoval=true) public DetectionBuilder 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
-
setEnable
public DetectionBuilder setEnable(java.lang.Boolean value)
-
addAugmentation
public DetectionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Detection> 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
-
addAugmentation
@Deprecated(forRemoval=true) public DetectionBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Detection>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Detection> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public DetectionBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Detection>> 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
-
-