Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109
Class ReportedHops1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109.ReportedHops1Builder
Class that builds
ReportedHops1
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:
ReportedHops1 createReportedHops1(int fooXyzzy, int barBaz) {
return new ReportedHops1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ReportedHops1, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedRecordRouteSubobjects
.Construct a builder initialized with state from specifiedReportedHops1
. -
Method Summary
Modifier and TypeMethodDescription@NonNull ReportedHops1
build()
A newReportedHops1
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toRecordRouteSubobjects.getProtectionAvailable()
.Return current value associated with the property corresponding toRecordRouteSubobjects.getProtectionInUse()
.Return current value associated with the property corresponding toRecordRouteSubobjects.getSubobjectType()
.setProtectionAvailable
(Boolean value) Set the property corresponding toRecordRouteSubobjects.getProtectionAvailable()
to the specified value.setProtectionInUse
(Boolean value) Set the property corresponding toRecordRouteSubobjects.getProtectionInUse()
to the specified value.setSubobjectType
(SubobjectType value) Set the property corresponding toRecordRouteSubobjects.getSubobjectType()
to the specified value.
-
Constructor Details
-
ReportedHops1Builder
public ReportedHops1Builder()Construct an empty builder. -
ReportedHops1Builder
Construct a new builder initialized from specifiedRecordRouteSubobjects
.- Parameters:
arg
- RecordRouteSubobjects from which the builder should be initialized
-
ReportedHops1Builder
Construct a builder initialized with state from specifiedReportedHops1
.- Parameters:
base
- ReportedHops1 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
-
getProtectionAvailable
Return current value associated with the property corresponding toRecordRouteSubobjects.getProtectionAvailable()
.- Returns:
- current value
-
getProtectionInUse
Return current value associated with the property corresponding toRecordRouteSubobjects.getProtectionInUse()
.- Returns:
- current value
-
getSubobjectType
Return current value associated with the property corresponding toRecordRouteSubobjects.getSubobjectType()
.- Returns:
- current value
-
setProtectionAvailable
Set the property corresponding toRecordRouteSubobjects.getProtectionAvailable()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtectionInUse
Set the property corresponding toRecordRouteSubobjects.getProtectionInUse()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSubobjectType
Set the property corresponding toRecordRouteSubobjects.getSubobjectType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newReportedHops1
instance.- Returns:
- A new
ReportedHops1
instance.
-