Class P2mpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.P2mpBuilder
-
@Generated("mdsal-binding-generator") public class P2mpBuilder extends Object
Class that buildsP2mp
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:
P2mp createP2mp(int fooXyzzy, int barBaz) { return new P2mpBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of P2mp, 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:
P2mp
- 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 P2mpBuilder()
Construct an empty builder.P2mpBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.P2mpBuilder(LoadBalancingObject arg)
Construct a new builder initialized from specifiedLoadBalancingObject
.P2mpBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.P2mpBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.P2mpBuilder(P2mp base)
Construct a builder initialized with state from specifiedP2mp
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description P2mpBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<P2mp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mp>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull P2mp
build()
A newP2mp
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
Return current value associated with the property corresponding toBandwidthObject.getBandwidth()
.List<EndpointRroPair>
getEndpointRroPair()
Return current value associated with the property corresponding toP2mp.getEndpointRroPair()
.IroBncChoice
getIroBncChoice()
Return current value associated with the property corresponding toP2mp.getIroBncChoice()
.LoadBalancing
getLoadBalancing()
Return current value associated with the property corresponding toLoadBalancingObject.getLoadBalancing()
.Lspa
getLspa()
Return current value associated with the property corresponding toLspaObject.getLspa()
.List<Metric>
getMetric()
Return current value associated with the property corresponding toP2mp.getMetric()
.Of
getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.P2mpBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mp>> augmentationType)
Remove an augmentation from this builder's product.P2mpBuilder
setBandwidth(Bandwidth value)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.P2mpBuilder
setEndpointRroPair(List<EndpointRroPair> values)
Set the property corresponding toP2mp.getEndpointRroPair()
to the specified value.P2mpBuilder
setIroBncChoice(IroBncChoice value)
Set the property corresponding toP2mp.getIroBncChoice()
to the specified value.P2mpBuilder
setLoadBalancing(LoadBalancing value)
Set the property corresponding toLoadBalancingObject.getLoadBalancing()
to the specified value.P2mpBuilder
setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.P2mpBuilder
setMetric(List<Metric> values)
Set the property corresponding toP2mp.getMetric()
to the specified value.P2mpBuilder
setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.
-
-
-
Constructor Detail
-
P2mpBuilder
public P2mpBuilder()
Construct an empty builder.
-
P2mpBuilder
public P2mpBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.- Parameters:
arg
- OfObject from which the builder should be initialized
-
P2mpBuilder
public P2mpBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.- Parameters:
arg
- LspaObject from which the builder should be initialized
-
P2mpBuilder
public P2mpBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.- Parameters:
arg
- BandwidthObject from which the builder should be initialized
-
P2mpBuilder
public P2mpBuilder(LoadBalancingObject arg)
Construct a new builder initialized from specifiedLoadBalancingObject
.- Parameters:
arg
- LoadBalancingObject 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
-
getBandwidth
public Bandwidth getBandwidth()
Return current value associated with the property corresponding toBandwidthObject.getBandwidth()
.- Returns:
- current value
-
getEndpointRroPair
public List<EndpointRroPair> getEndpointRroPair()
Return current value associated with the property corresponding toP2mp.getEndpointRroPair()
.- Returns:
- current value
-
getIroBncChoice
public IroBncChoice getIroBncChoice()
Return current value associated with the property corresponding toP2mp.getIroBncChoice()
.- Returns:
- current value
-
getLoadBalancing
public LoadBalancing getLoadBalancing()
Return current value associated with the property corresponding toLoadBalancingObject.getLoadBalancing()
.- Returns:
- current value
-
getLspa
public Lspa getLspa()
Return current value associated with the property corresponding toLspaObject.getLspa()
.- Returns:
- current value
-
getMetric
public List<Metric> getMetric()
Return current value associated with the property corresponding toP2mp.getMetric()
.- Returns:
- current value
-
getOf
public Of getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mp>> 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
-
setBandwidth
public P2mpBuilder setBandwidth(Bandwidth value)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEndpointRroPair
public P2mpBuilder setEndpointRroPair(List<EndpointRroPair> values)
Set the property corresponding toP2mp.getEndpointRroPair()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setIroBncChoice
public P2mpBuilder setIroBncChoice(IroBncChoice value)
Set the property corresponding toP2mp.getIroBncChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLoadBalancing
public P2mpBuilder setLoadBalancing(LoadBalancing value)
Set the property corresponding toLoadBalancingObject.getLoadBalancing()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspa
public P2mpBuilder setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetric
public P2mpBuilder setMetric(List<Metric> values)
Set the property corresponding toP2mp.getMetric()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setOf
public P2mpBuilder setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public P2mpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<P2mp> 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 P2mpBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mp>> 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
-
-