Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.open.msg
Class CParameters1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.open.msg.CParameters1Builder
Class that builds
CParameters1
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:
CParameters1 createCParameters1(int fooXyzzy, int barBaz) {
return new CParameters1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of CParameters1, 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 new builder initialized from specifiedMpCapabilities
.Construct a builder initialized with state from specifiedCParameters1
. -
Method Summary
Modifier and TypeMethodDescription@NonNull CParameters1
build()
A newCParameters1
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMpCapabilities.getAddPathCapability()
.Return current value associated with the property corresponding toMpCapabilities.getGracefulRestartCapability()
.Return current value associated with the property corresponding toMpCapabilities.getLlGracefulRestartCapability()
.Return current value associated with the property corresponding toMpCapabilities.getMultiprotocolCapability()
.Return current value associated with the property corresponding toMpCapabilities.getRouteRefreshCapability()
.Set the property corresponding toMpCapabilities.getAddPathCapability()
to the specified value.Set the property corresponding toMpCapabilities.getGracefulRestartCapability()
to the specified value.Set the property corresponding toMpCapabilities.getLlGracefulRestartCapability()
to the specified value.Set the property corresponding toMpCapabilities.getMultiprotocolCapability()
to the specified value.Set the property corresponding toMpCapabilities.getRouteRefreshCapability()
to the specified value.
-
Constructor Details
-
CParameters1Builder
public CParameters1Builder()Construct an empty builder. -
CParameters1Builder
Construct a new builder initialized from specifiedMpCapabilities
.- Parameters:
arg
- MpCapabilities from which the builder should be initialized
-
CParameters1Builder
Construct a builder initialized with state from specifiedCParameters1
.- Parameters:
base
- CParameters1 from which the builder should be initialized
-
-
Method Details
-
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
-
getAddPathCapability
Return current value associated with the property corresponding toMpCapabilities.getAddPathCapability()
.- Returns:
- current value
-
getGracefulRestartCapability
Return current value associated with the property corresponding toMpCapabilities.getGracefulRestartCapability()
.- Returns:
- current value
-
getLlGracefulRestartCapability
Return current value associated with the property corresponding toMpCapabilities.getLlGracefulRestartCapability()
.- Returns:
- current value
-
getMultiprotocolCapability
Return current value associated with the property corresponding toMpCapabilities.getMultiprotocolCapability()
.- Returns:
- current value
-
getRouteRefreshCapability
Return current value associated with the property corresponding toMpCapabilities.getRouteRefreshCapability()
.- Returns:
- current value
-
setAddPathCapability
Set the property corresponding toMpCapabilities.getAddPathCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGracefulRestartCapability
Set the property corresponding toMpCapabilities.getGracefulRestartCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLlGracefulRestartCapability
Set the property corresponding toMpCapabilities.getLlGracefulRestartCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMultiprotocolCapability
Set the property corresponding toMpCapabilities.getMultiprotocolCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteRefreshCapability
Set the property corresponding toMpCapabilities.getRouteRefreshCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newCParameters1
instance.- Returns:
- A new
CParameters1
instance.
-