Class P2pBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.P2pBuilder
-
@Generated("mdsal-binding-generator") public class P2pBuilder extends Object
Class that buildsP2p
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:
P2p createP2p(int fooXyzzy, int barBaz) { return new P2pBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of P2p, 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:
P2p
- 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 P2pBuilder()
Construct an empty builder.P2pBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.P2pBuilder(ClasstypeObject arg)
Construct a new builder initialized from specifiedClasstypeObject
.P2pBuilder(EndpointsObject arg)
Construct a new builder initialized from specifiedEndpointsObject
.P2pBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.P2pBuilder(IncludeRouteObject arg)
Construct a new builder initialized from specifiedIncludeRouteObject
.P2pBuilder(LoadBalancingObject arg)
Construct a new builder initialized from specifiedLoadBalancingObject
.P2pBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.P2pBuilder(LspAttributes arg)
Construct a new builder initialized from specifiedLspAttributes
.P2pBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.P2pBuilder(P2p base)
Construct a builder initialized with state from specifiedP2p
.P2pBuilder(ReoptimizationBandwidthObject arg)
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.P2pBuilder(ReportedRouteObject arg)
Construct a new builder initialized from specifiedReportedRouteObject
.P2pBuilder(VendorInformationObjects arg)
Construct a new builder initialized from specifiedVendorInformationObjects
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description P2pBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<P2p> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<P2p>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull P2p
build()
A newP2p
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()
.ClassType
getClassType()
Return current value associated with the property corresponding toClasstypeObject.getClassType()
.EndpointsObj
getEndpointsObj()
Return current value associated with the property corresponding toEndpointsObject.getEndpointsObj()
.Iro
getIro()
Return current value associated with the property corresponding toIncludeRouteObject.getIro()
.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<Metrics>
getMetrics()
Return current value associated with the property corresponding toLspAttributes.getMetrics()
.Of
getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.ReoptimizationBandwidth
getReoptimizationBandwidth()
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.ReportedRoute
getReportedRoute()
Return current value associated with the property corresponding toP2p.getReportedRoute()
.Rro
getRro()
Return current value associated with the property corresponding toReportedRouteObject.getRro()
.List<VendorInformationObject>
getVendorInformationObject()
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.Xro
getXro()
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.P2pBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2p>> augmentationType)
Remove an augmentation from this builder's product.P2pBuilder
setBandwidth(Bandwidth value)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.P2pBuilder
setClassType(ClassType value)
Set the property corresponding toClasstypeObject.getClassType()
to the specified value.P2pBuilder
setEndpointsObj(EndpointsObj value)
Set the property corresponding toEndpointsObject.getEndpointsObj()
to the specified value.P2pBuilder
setIro(Iro value)
Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.P2pBuilder
setLoadBalancing(LoadBalancing value)
Set the property corresponding toLoadBalancingObject.getLoadBalancing()
to the specified value.P2pBuilder
setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.P2pBuilder
setMetrics(List<Metrics> values)
Set the property corresponding toLspAttributes.getMetrics()
to the specified value.P2pBuilder
setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.P2pBuilder
setReoptimizationBandwidth(ReoptimizationBandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.P2pBuilder
setReportedRoute(ReportedRoute value)
Set the property corresponding toP2p.getReportedRoute()
to the specified value.P2pBuilder
setRro(Rro value)
Set the property corresponding toReportedRouteObject.getRro()
to the specified value.P2pBuilder
setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.P2pBuilder
setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.
-
-
-
Constructor Detail
-
P2pBuilder
public P2pBuilder()
Construct an empty builder.
-
P2pBuilder
public P2pBuilder(EndpointsObject arg)
Construct a new builder initialized from specifiedEndpointsObject
.- Parameters:
arg
- EndpointsObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(VendorInformationObjects arg)
Construct a new builder initialized from specifiedVendorInformationObjects
.- Parameters:
arg
- VendorInformationObjects from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(LoadBalancingObject arg)
Construct a new builder initialized from specifiedLoadBalancingObject
.- Parameters:
arg
- LoadBalancingObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(LspAttributes arg)
Construct a new builder initialized from specifiedLspAttributes
.- Parameters:
arg
- LspAttributes from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.- Parameters:
arg
- LspaObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.- Parameters:
arg
- BandwidthObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(ReoptimizationBandwidthObject arg)
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.- Parameters:
arg
- ReoptimizationBandwidthObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(IncludeRouteObject arg)
Construct a new builder initialized from specifiedIncludeRouteObject
.- Parameters:
arg
- IncludeRouteObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(ReportedRouteObject arg)
Construct a new builder initialized from specifiedReportedRouteObject
.- Parameters:
arg
- ReportedRouteObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.- Parameters:
arg
- ExcludeRouteObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.- Parameters:
arg
- OfObject from which the builder should be initialized
-
P2pBuilder
public P2pBuilder(ClasstypeObject arg)
Construct a new builder initialized from specifiedClasstypeObject
.- Parameters:
arg
- ClasstypeObject 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
-
getClassType
public ClassType getClassType()
Return current value associated with the property corresponding toClasstypeObject.getClassType()
.- Returns:
- current value
-
getEndpointsObj
public EndpointsObj getEndpointsObj()
Return current value associated with the property corresponding toEndpointsObject.getEndpointsObj()
.- Returns:
- current value
-
getIro
public Iro getIro()
Return current value associated with the property corresponding toIncludeRouteObject.getIro()
.- 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
-
getMetrics
public List<Metrics> getMetrics()
Return current value associated with the property corresponding toLspAttributes.getMetrics()
.- Returns:
- current value
-
getOf
public Of getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.- Returns:
- current value
-
getReoptimizationBandwidth
public ReoptimizationBandwidth getReoptimizationBandwidth()
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.- Returns:
- current value
-
getReportedRoute
public ReportedRoute getReportedRoute()
Return current value associated with the property corresponding toP2p.getReportedRoute()
.- Returns:
- current value
-
getRro
public Rro getRro()
Return current value associated with the property corresponding toReportedRouteObject.getRro()
.- Returns:
- current value
-
getVendorInformationObject
public List<VendorInformationObject> getVendorInformationObject()
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.- Returns:
- current value
-
getXro
public Xro getXro()
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<P2p>> 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 P2pBuilder setBandwidth(Bandwidth value)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setClassType
public P2pBuilder setClassType(ClassType value)
Set the property corresponding toClasstypeObject.getClassType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEndpointsObj
public P2pBuilder setEndpointsObj(EndpointsObj value)
Set the property corresponding toEndpointsObject.getEndpointsObj()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIro
public P2pBuilder setIro(Iro value)
Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLoadBalancing
public P2pBuilder setLoadBalancing(LoadBalancing value)
Set the property corresponding toLoadBalancingObject.getLoadBalancing()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspa
public P2pBuilder setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetrics
public P2pBuilder setMetrics(List<Metrics> values)
Set the property corresponding toLspAttributes.getMetrics()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setOf
public P2pBuilder setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReoptimizationBandwidth
public P2pBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReportedRoute
public P2pBuilder setReportedRoute(ReportedRoute value)
Set the property corresponding toP2p.getReportedRoute()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRro
public P2pBuilder setRro(Rro value)
Set the property corresponding toReportedRouteObject.getRro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVendorInformationObject
public P2pBuilder setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setXro
public P2pBuilder setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public P2pBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<P2p> 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 P2pBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2p>> 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
-
-