Class PcepSessionStateBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.grouping.PcepSessionStateBuilder
Class that builds
PcepSessionState
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:
PcepSessionState createPcepSessionState(int fooXyzzy, int barBaz) {
return new PcepSessionStateBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PcepSessionState, 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 specifiedPcepSessionState
.Construct a new builder initialized from specifiedPcepSessionState
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<PcepSessionState> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<PcepSessionState>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PcepSessionState
build()
A newPcepSessionState
instance.static @NonNull PcepSessionState
empty()
Get empty instance of PcepSessionState.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toPcepSessionState.getDelegatedLspsCount()
.Return current value associated with the property corresponding toPcepSessionState.getLocalPref()
.Return current value associated with the property corresponding toPcepSessionState.getMessages()
.Return current value associated with the property corresponding toPcepSessionState.getPeerCapabilities()
.Return current value associated with the property corresponding toPcepSessionState.getPeerPref()
.Return current value associated with the property corresponding toPcepSessionState.getSessionDuration()
.Return current value associated with the property corresponding toPcepSessionState.getSynchronized()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<PcepSessionState>> augmentationType) Remove an augmentation from this builder's product.setDelegatedLspsCount
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toPcepSessionState.getDelegatedLspsCount()
to the specified value.setLocalPref
(LocalPref value) Set the property corresponding toPcepSessionState.getLocalPref()
to the specified value.setMessages
(Messages value) Set the property corresponding toPcepSessionState.getMessages()
to the specified value.Set the property corresponding toPcepSessionState.getPeerCapabilities()
to the specified value.setPeerPref
(PeerPref value) Set the property corresponding toPcepSessionState.getPeerPref()
to the specified value.setSessionDuration
(String value) Set the property corresponding toPcepSessionState.getSessionDuration()
to the specified value.setSynchronized
(Boolean value) Set the property corresponding toPcepSessionState.getSynchronized()
to the specified value.
-
Constructor Details
-
PcepSessionStateBuilder
public PcepSessionStateBuilder()Construct an empty builder. -
PcepSessionStateBuilder
Construct a new builder initialized from specifiedPcepSessionState
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.PcepSessionState from which the builder should be initialized
-
PcepSessionStateBuilder
Construct a builder initialized with state from specifiedPcepSessionState
.- Parameters:
base
- PcepSessionState from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Get empty instance of PcepSessionState.- Returns:
- An empty
PcepSessionState
-
getDelegatedLspsCount
public org.opendaylight.yangtools.yang.common.Uint16 getDelegatedLspsCount()Return current value associated with the property corresponding toPcepSessionState.getDelegatedLspsCount()
.- Returns:
- current value
-
getLocalPref
Return current value associated with the property corresponding toPcepSessionState.getLocalPref()
.- Returns:
- current value
-
getMessages
Return current value associated with the property corresponding toPcepSessionState.getMessages()
.- Returns:
- current value
-
getPeerCapabilities
Return current value associated with the property corresponding toPcepSessionState.getPeerCapabilities()
.- Returns:
- current value
-
getPeerPref
Return current value associated with the property corresponding toPcepSessionState.getPeerPref()
.- Returns:
- current value
-
getSessionDuration
Return current value associated with the property corresponding toPcepSessionState.getSessionDuration()
.- Returns:
- current value
-
getSynchronized
Return current value associated with the property corresponding toPcepSessionState.getSynchronized()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<PcepSessionState>> 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
-
setDelegatedLspsCount
public PcepSessionStateBuilder setDelegatedLspsCount(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toPcepSessionState.getDelegatedLspsCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalPref
Set the property corresponding toPcepSessionState.getLocalPref()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMessages
Set the property corresponding toPcepSessionState.getMessages()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerCapabilities
Set the property corresponding toPcepSessionState.getPeerCapabilities()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerPref
Set the property corresponding toPcepSessionState.getPeerPref()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSessionDuration
Set the property corresponding toPcepSessionState.getSessionDuration()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSynchronized
Set the property corresponding toPcepSessionState.getSynchronized()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcepSessionStateBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<PcepSessionState> 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 PcepSessionStateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<PcepSessionState>> 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 newPcepSessionState
instance.- Returns:
- A new
PcepSessionState
instance.
-