Class PcepIetfStatefulConfigBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.ietf.stateful.app.config.rev160707.PcepIetfStatefulConfigBuilder
Class that builds
PcepIetfStatefulConfig
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:
PcepIetfStatefulConfig createPcepIetfStatefulConfig(int fooXyzzy, int barBaz) {
return new PcepIetfStatefulConfigBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PcepIetfStatefulConfig, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedPcepIetfStatefulConfig
.Construct a new builder initialized from specifiedStatefulCapabilities
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PcepIetfStatefulConfig
build()
A newPcepIetfStatefulConfig
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toStatefulCapabilities.getActive()
.Return current value associated with the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
.Return current value associated with the property corresponding toStatefulCapabilities.getIncludeDbVersion()
.Return current value associated with the property corresponding toStatefulCapabilities.getInitiated()
.Return current value associated with the property corresponding toStatefulCapabilities.getStateful()
.Return current value associated with the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
.Return current value associated with the property corresponding toStatefulCapabilities.getTriggeredResync()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toStatefulCapabilities.getActive()
to the specified value.setDeltaLspSyncCapability
(Boolean value) Set the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
to the specified value.setIncludeDbVersion
(Boolean value) Set the property corresponding toStatefulCapabilities.getIncludeDbVersion()
to the specified value.setInitiated
(Boolean value) Set the property corresponding toStatefulCapabilities.getInitiated()
to the specified value.setStateful
(Boolean value) Set the property corresponding toStatefulCapabilities.getStateful()
to the specified value.setTriggeredInitialSync
(Boolean value) Set the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
to the specified value.setTriggeredResync
(Boolean value) Set the property corresponding toStatefulCapabilities.getTriggeredResync()
to the specified value.
-
Constructor Details
-
PcepIetfStatefulConfigBuilder
public PcepIetfStatefulConfigBuilder()Construct an empty builder. -
PcepIetfStatefulConfigBuilder
Construct a new builder initialized from specifiedStatefulCapabilities
.- Parameters:
arg
- StatefulCapabilities from which the builder should be initialized
-
PcepIetfStatefulConfigBuilder
Construct a builder initialized with state from specifiedPcepIetfStatefulConfig
.- Parameters:
base
- PcepIetfStatefulConfig from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getActive
Return current value associated with the property corresponding toStatefulCapabilities.getActive()
.- Returns:
- current value
-
getDeltaLspSyncCapability
Return current value associated with the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
.- Returns:
- current value
-
getIncludeDbVersion
Return current value associated with the property corresponding toStatefulCapabilities.getIncludeDbVersion()
.- Returns:
- current value
-
getInitiated
Return current value associated with the property corresponding toStatefulCapabilities.getInitiated()
.- Returns:
- current value
-
getStateful
Return current value associated with the property corresponding toStatefulCapabilities.getStateful()
.- Returns:
- current value
-
getTriggeredInitialSync
Return current value associated with the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
.- Returns:
- current value
-
getTriggeredResync
Return current value associated with the property corresponding toStatefulCapabilities.getTriggeredResync()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setActive
Set the property corresponding toStatefulCapabilities.getActive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDeltaLspSyncCapability
Set the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIncludeDbVersion
Set the property corresponding toStatefulCapabilities.getIncludeDbVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInitiated
Set the property corresponding toStatefulCapabilities.getInitiated()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStateful
Set the property corresponding toStatefulCapabilities.getStateful()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTriggeredInitialSync
Set the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTriggeredResync
Set the property corresponding toStatefulCapabilities.getTriggeredResync()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
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
A newPcepIetfStatefulConfig
instance.- Returns:
- A new
PcepIetfStatefulConfig
instance.
-