Class PcepIetfStatefulConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.ietf.stateful.app.config.rev160707.PcepIetfStatefulConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PcepIetfStatefulConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PcepIetfStatefulConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PcepIetfStatefulConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PcepIetfStatefulConfig>
Class that buildsPcepIetfStatefulConfigBuilder
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:
PcepIetfStatefulConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new PcepIetfStatefulConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcepIetfStatefulConfigBuilder, 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:
PcepIetfStatefulConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PcepIetfStatefulConfigBuilder()
PcepIetfStatefulConfigBuilder(PcepIetfStatefulConfig base)
PcepIetfStatefulConfigBuilder(StatefulCapabilities arg)
-
Method Summary
-
-
-
Constructor Detail
-
PcepIetfStatefulConfigBuilder
public PcepIetfStatefulConfigBuilder()
-
PcepIetfStatefulConfigBuilder
public PcepIetfStatefulConfigBuilder(StatefulCapabilities arg)
-
PcepIetfStatefulConfigBuilder
public PcepIetfStatefulConfigBuilder(PcepIetfStatefulConfig base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.ietf.stateful.app.config.rev160707.StatefulCapabilities
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
isActive
public Boolean isActive()
-
isDeltaLspSyncCapability
public Boolean isDeltaLspSyncCapability()
-
isIncludeDbVersion
public Boolean isIncludeDbVersion()
-
isInitiated
public Boolean isInitiated()
-
isStateful
public Boolean isStateful()
-
isTriggeredInitialSync
public Boolean isTriggeredInitialSync()
-
isTriggeredResync
public Boolean isTriggeredResync()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
setActive
public PcepIetfStatefulConfigBuilder setActive(Boolean value)
-
setDeltaLspSyncCapability
public PcepIetfStatefulConfigBuilder setDeltaLspSyncCapability(Boolean value)
-
setIncludeDbVersion
public PcepIetfStatefulConfigBuilder setIncludeDbVersion(Boolean value)
-
setInitiated
public PcepIetfStatefulConfigBuilder setInitiated(Boolean value)
-
setStateful
public PcepIetfStatefulConfigBuilder setStateful(Boolean value)
-
setTriggeredInitialSync
public PcepIetfStatefulConfigBuilder setTriggeredInitialSync(Boolean value)
-
setTriggeredResync
public PcepIetfStatefulConfigBuilder setTriggeredResync(Boolean value)
-
addAugmentation
public PcepIetfStatefulConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public PcepIetfStatefulConfigBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig> 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 PcepIetfStatefulConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig>> 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 PcepIetfStatefulConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PcepIetfStatefulConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PcepIetfStatefulConfig,IllegalArgumentException>
-
-