Class PcepSessionStateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.grouping.PcepSessionStateBuilder
-
@Generated("mdsal-binding-generator") public class PcepSessionStateBuilder extends Object
Class that buildsPcepSessionState
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:
PcepSessionState
- 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 PcepSessionStateBuilder()
Construct an empty builder.PcepSessionStateBuilder(PcepSessionState base)
Construct a builder initialized with state from specifiedPcepSessionState
.PcepSessionStateBuilder(PcepSessionState arg)
Construct a new builder initialized from specifiedPcepSessionState
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcepSessionStateBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionState> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.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.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getDelegatedLspsCount()
Return current value associated with the property corresponding toPcepSessionState.getDelegatedLspsCount()
.LocalPref
getLocalPref()
Return current value associated with the property corresponding toPcepSessionState.getLocalPref()
.Messages
getMessages()
Return current value associated with the property corresponding toPcepSessionState.getMessages()
.PeerCapabilities
getPeerCapabilities()
Return current value associated with the property corresponding toPcepSessionState.getPeerCapabilities()
.PeerPref
getPeerPref()
Return current value associated with the property corresponding toPcepSessionState.getPeerPref()
.String
getSessionDuration()
Return current value associated with the property corresponding toPcepSessionState.getSessionDuration()
.Boolean
getSynchronized()
Return current value associated with the property corresponding toPcepSessionState.getSynchronized()
.PcepSessionStateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionState>> augmentationType)
Remove an augmentation from this builder's product.PcepSessionStateBuilder
setDelegatedLspsCount(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepSessionState.getDelegatedLspsCount()
to the specified value.PcepSessionStateBuilder
setLocalPref(LocalPref value)
Set the property corresponding toPcepSessionState.getLocalPref()
to the specified value.PcepSessionStateBuilder
setMessages(Messages value)
Set the property corresponding toPcepSessionState.getMessages()
to the specified value.PcepSessionStateBuilder
setPeerCapabilities(PeerCapabilities value)
Set the property corresponding toPcepSessionState.getPeerCapabilities()
to the specified value.PcepSessionStateBuilder
setPeerPref(PeerPref value)
Set the property corresponding toPcepSessionState.getPeerPref()
to the specified value.PcepSessionStateBuilder
setSessionDuration(String value)
Set the property corresponding toPcepSessionState.getSessionDuration()
to the specified value.PcepSessionStateBuilder
setSynchronized(Boolean value)
Set the property corresponding toPcepSessionState.getSynchronized()
to the specified value.
-
-
-
Constructor Detail
-
PcepSessionStateBuilder
public PcepSessionStateBuilder()
Construct an empty builder.
-
PcepSessionStateBuilder
public PcepSessionStateBuilder(PcepSessionState arg)
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
public PcepSessionStateBuilder(PcepSessionState base)
Construct a builder initialized with state from specifiedPcepSessionState
.- Parameters:
base
- PcepSessionState 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
-
getDelegatedLspsCount
public org.opendaylight.yangtools.yang.common.Uint16 getDelegatedLspsCount()
Return current value associated with the property corresponding toPcepSessionState.getDelegatedLspsCount()
.- Returns:
- current value
-
getLocalPref
public LocalPref getLocalPref()
Return current value associated with the property corresponding toPcepSessionState.getLocalPref()
.- Returns:
- current value
-
getMessages
public Messages getMessages()
Return current value associated with the property corresponding toPcepSessionState.getMessages()
.- Returns:
- current value
-
getPeerCapabilities
public PeerCapabilities getPeerCapabilities()
Return current value associated with the property corresponding toPcepSessionState.getPeerCapabilities()
.- Returns:
- current value
-
getPeerPref
public PeerPref getPeerPref()
Return current value associated with the property corresponding toPcepSessionState.getPeerPref()
.- Returns:
- current value
-
getSessionDuration
public String getSessionDuration()
Return current value associated with the property corresponding toPcepSessionState.getSessionDuration()
.- Returns:
- current value
-
getSynchronized
public Boolean getSynchronized()
Return current value associated with the property corresponding toPcepSessionState.getSynchronized()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.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
public PcepSessionStateBuilder setLocalPref(LocalPref value)
Set the property corresponding toPcepSessionState.getLocalPref()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMessages
public PcepSessionStateBuilder setMessages(Messages value)
Set the property corresponding toPcepSessionState.getMessages()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerCapabilities
public PcepSessionStateBuilder setPeerCapabilities(PeerCapabilities value)
Set the property corresponding toPcepSessionState.getPeerCapabilities()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerPref
public PcepSessionStateBuilder setPeerPref(PeerPref value)
Set the property corresponding toPcepSessionState.getPeerPref()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSessionDuration
public PcepSessionStateBuilder setSessionDuration(String value)
Set the property corresponding toPcepSessionState.getSessionDuration()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSynchronized
public PcepSessionStateBuilder setSynchronized(Boolean value)
Set the property corresponding toPcepSessionState.getSynchronized()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcepSessionStateBuilder addAugmentation(org.opendaylight.yangtools.yang.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.yang.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
public @NonNull PcepSessionState build()
A newPcepSessionState
instance.- Returns:
- A new
PcepSessionState
instance.
-
-