Class PcepIetfStatefulConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.ietf.stateful.app.config.rev160707.PcepIetfStatefulConfigBuilder
-
@Generated("mdsal-binding-generator") public class PcepIetfStatefulConfigBuilder extends Object
Class that buildsPcepIetfStatefulConfig
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:
PcepIetfStatefulConfig
- 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
-
-
Constructor Summary
Constructors Constructor Description PcepIetfStatefulConfigBuilder()
Construct an empty builder.PcepIetfStatefulConfigBuilder(PcepIetfStatefulConfig base)
Construct a builder initialized with state from specifiedPcepIetfStatefulConfig
.PcepIetfStatefulConfigBuilder(StatefulCapabilities arg)
Construct a new builder initialized from specifiedStatefulCapabilities
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcepIetfStatefulConfigBuilder
addAugmentation(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.Boolean
getActive()
Return current value associated with the property corresponding toStatefulCapabilities.getActive()
.Boolean
getDeltaLspSyncCapability()
Return current value associated with the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
.Boolean
getIncludeDbVersion()
Return current value associated with the property corresponding toStatefulCapabilities.getIncludeDbVersion()
.Boolean
getInitiated()
Return current value associated with the property corresponding toStatefulCapabilities.getInitiated()
.Boolean
getStateful()
Return current value associated with the property corresponding toStatefulCapabilities.getStateful()
.Boolean
getTriggeredInitialSync()
Return current value associated with the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
.Boolean
getTriggeredResync()
Return current value associated with the property corresponding toStatefulCapabilities.getTriggeredResync()
.PcepIetfStatefulConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepIetfStatefulConfig>> augmentationType)
Remove an augmentation from this builder's product.PcepIetfStatefulConfigBuilder
setActive(Boolean value)
Set the property corresponding toStatefulCapabilities.getActive()
to the specified value.PcepIetfStatefulConfigBuilder
setDeltaLspSyncCapability(Boolean value)
Set the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
to the specified value.PcepIetfStatefulConfigBuilder
setIncludeDbVersion(Boolean value)
Set the property corresponding toStatefulCapabilities.getIncludeDbVersion()
to the specified value.PcepIetfStatefulConfigBuilder
setInitiated(Boolean value)
Set the property corresponding toStatefulCapabilities.getInitiated()
to the specified value.PcepIetfStatefulConfigBuilder
setStateful(Boolean value)
Set the property corresponding toStatefulCapabilities.getStateful()
to the specified value.PcepIetfStatefulConfigBuilder
setTriggeredInitialSync(Boolean value)
Set the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
to the specified value.PcepIetfStatefulConfigBuilder
setTriggeredResync(Boolean value)
Set the property corresponding toStatefulCapabilities.getTriggeredResync()
to the specified value.
-
-
-
Constructor Detail
-
PcepIetfStatefulConfigBuilder
public PcepIetfStatefulConfigBuilder()
Construct an empty builder.
-
PcepIetfStatefulConfigBuilder
public PcepIetfStatefulConfigBuilder(StatefulCapabilities arg)
Construct a new builder initialized from specifiedStatefulCapabilities
.- Parameters:
arg
- StatefulCapabilities from which the builder should be initialized
-
PcepIetfStatefulConfigBuilder
public PcepIetfStatefulConfigBuilder(PcepIetfStatefulConfig base)
Construct a builder initialized with state from specifiedPcepIetfStatefulConfig
.- Parameters:
base
- PcepIetfStatefulConfig from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getActive
public Boolean getActive()
Return current value associated with the property corresponding toStatefulCapabilities.getActive()
.- Returns:
- current value
-
getDeltaLspSyncCapability
public Boolean getDeltaLspSyncCapability()
Return current value associated with the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
.- Returns:
- current value
-
getIncludeDbVersion
public Boolean getIncludeDbVersion()
Return current value associated with the property corresponding toStatefulCapabilities.getIncludeDbVersion()
.- Returns:
- current value
-
getInitiated
public Boolean getInitiated()
Return current value associated with the property corresponding toStatefulCapabilities.getInitiated()
.- Returns:
- current value
-
getStateful
public Boolean getStateful()
Return current value associated with the property corresponding toStatefulCapabilities.getStateful()
.- Returns:
- current value
-
getTriggeredInitialSync
public Boolean getTriggeredInitialSync()
Return current value associated with the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
.- Returns:
- current value
-
getTriggeredResync
public Boolean 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
public PcepIetfStatefulConfigBuilder setActive(Boolean value)
Set the property corresponding toStatefulCapabilities.getActive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDeltaLspSyncCapability
public PcepIetfStatefulConfigBuilder setDeltaLspSyncCapability(Boolean value)
Set the property corresponding toStatefulCapabilities.getDeltaLspSyncCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIncludeDbVersion
public PcepIetfStatefulConfigBuilder setIncludeDbVersion(Boolean value)
Set the property corresponding toStatefulCapabilities.getIncludeDbVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInitiated
public PcepIetfStatefulConfigBuilder setInitiated(Boolean value)
Set the property corresponding toStatefulCapabilities.getInitiated()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStateful
public PcepIetfStatefulConfigBuilder setStateful(Boolean value)
Set the property corresponding toStatefulCapabilities.getStateful()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTriggeredInitialSync
public PcepIetfStatefulConfigBuilder setTriggeredInitialSync(Boolean value)
Set the property corresponding toStatefulCapabilities.getTriggeredInitialSync()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTriggeredResync
public PcepIetfStatefulConfigBuilder setTriggeredResync(Boolean value)
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
public @NonNull PcepIetfStatefulConfig build()
A newPcepIetfStatefulConfig
instance.- Returns:
- A new
PcepIetfStatefulConfig
instance.
-
-