Class ConsistencyCheckerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.ConsistencyCheckerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ConsistencyChecker>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ConsistencyChecker,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ConsistencyCheckerBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<ConsistencyChecker>
Class that buildsConsistencyCheckerBuilder
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:
ConsistencyCheckerBuilder createTarget(int fooXyzzy, int barBaz) { return new ConsistencyCheckerBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConsistencyCheckerBuilder, 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:
ConsistencyCheckerBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConsistencyCheckerBuilder()
ConsistencyCheckerBuilder(ConsistencyChecker base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConsistencyCheckerBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
ConsistencyChecker
build()
InconsistencyAction
getInconsistencyAction()
org.opendaylight.yangtools.yang.common.Uint16
getInterval()
java.lang.Boolean
isEnable()
ConsistencyCheckerBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker>> augmentationType)
ConsistencyCheckerBuilder
setEnable(java.lang.Boolean value)
ConsistencyCheckerBuilder
setInconsistencyAction(InconsistencyAction value)
ConsistencyCheckerBuilder
setInterval(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setInterval(Uint16)} instead.ConsistencyCheckerBuilder
setInterval(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
ConsistencyCheckerBuilder
public ConsistencyCheckerBuilder()
-
ConsistencyCheckerBuilder
public ConsistencyCheckerBuilder(ConsistencyChecker base)
-
-
Method Detail
-
getInconsistencyAction
public InconsistencyAction getInconsistencyAction()
-
getInterval
public org.opendaylight.yangtools.yang.common.Uint16 getInterval()
-
isEnable
public java.lang.Boolean isEnable()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setInconsistencyAction
public ConsistencyCheckerBuilder setInconsistencyAction(InconsistencyAction value)
-
setInterval
public ConsistencyCheckerBuilder setInterval(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInterval
@Deprecated(forRemoval=true) public ConsistencyCheckerBuilder setInterval(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setInterval(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setEnable
public ConsistencyCheckerBuilder setEnable(java.lang.Boolean value)
-
addAugmentation
public ConsistencyCheckerBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker> augmentationValue)
-
removeAugmentation
public ConsistencyCheckerBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConsistencyChecker>> augmentationType)
-
build
public ConsistencyChecker build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ConsistencyChecker>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ConsistencyChecker,java.lang.IllegalArgumentException>
-
-