Class CParametersBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParametersBuilder
-
@Generated("mdsal-binding-generator") public class CParametersBuilder extends Object
Class that buildsCParameters
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:
CParameters createCParameters(int fooXyzzy, int barBaz) { return new CParametersBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CParameters, 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:
CParameters
- 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 CParametersBuilder()
Construct an empty builder.CParametersBuilder(CParameters base)
Construct a builder initialized with state from specifiedCParameters
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CParametersBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CParameters> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CParameters>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull CParameters
build()
A newCParameters
instance.As4BytesCapability
getAs4BytesCapability()
Return current value associated with the property corresponding toCParameters.getAs4BytesCapability()
.BgpExtendedMessageCapability
getBgpExtendedMessageCapability()
Return current value associated with the property corresponding toCParameters.getBgpExtendedMessageCapability()
.CParametersBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CParameters>> augmentationType)
Remove an augmentation from this builder's product.CParametersBuilder
setAs4BytesCapability(As4BytesCapability value)
Set the property corresponding toCParameters.getAs4BytesCapability()
to the specified value.CParametersBuilder
setBgpExtendedMessageCapability(BgpExtendedMessageCapability value)
Set the property corresponding toCParameters.getBgpExtendedMessageCapability()
to the specified value.
-
-
-
Constructor Detail
-
CParametersBuilder
public CParametersBuilder()
Construct an empty builder.
-
CParametersBuilder
public CParametersBuilder(CParameters base)
Construct a builder initialized with state from specifiedCParameters
.- Parameters:
base
- CParameters from which the builder should be initialized
-
-
Method Detail
-
getAs4BytesCapability
public As4BytesCapability getAs4BytesCapability()
Return current value associated with the property corresponding toCParameters.getAs4BytesCapability()
.- Returns:
- current value
-
getBgpExtendedMessageCapability
public BgpExtendedMessageCapability getBgpExtendedMessageCapability()
Return current value associated with the property corresponding toCParameters.getBgpExtendedMessageCapability()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CParameters>> 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
-
setAs4BytesCapability
public CParametersBuilder setAs4BytesCapability(As4BytesCapability value)
Set the property corresponding toCParameters.getAs4BytesCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBgpExtendedMessageCapability
public CParametersBuilder setBgpExtendedMessageCapability(BgpExtendedMessageCapability value)
Set the property corresponding toCParameters.getBgpExtendedMessageCapability()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CParametersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CParameters> 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 CParametersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CParameters>> 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 CParameters build()
A newCParameters
instance.- Returns:
- A new
CParameters
instance.
-
-