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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<CParameters>
,org.opendaylight.yangtools.concepts.CheckedBuilder<CParameters,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class CParametersBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<CParameters>
Class that buildsCParametersBuilder
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:
CParametersBuilder createTarget(int fooXyzzy, int barBaz) { return new CParametersBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CParametersBuilder, 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 oportunities, 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:
CParametersBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CParametersBuilder()
CParametersBuilder(CParameters base)
-
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)
CParameters
build()
As4BytesCapability
getAs4BytesCapability()
BgpExtendedMessageCapability
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)
CParametersBuilder
setBgpExtendedMessageCapability(BgpExtendedMessageCapability value)
-
-
-
Constructor Detail
-
CParametersBuilder
public CParametersBuilder()
-
CParametersBuilder
public CParametersBuilder(CParameters base)
-
-
Method Detail
-
getAs4BytesCapability
public As4BytesCapability getAs4BytesCapability()
-
getBgpExtendedMessageCapability
public BgpExtendedMessageCapability getBgpExtendedMessageCapability()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CParameters>> E$$ augmentation(Class<E$$> augmentationType)
-
setAs4BytesCapability
public CParametersBuilder setAs4BytesCapability(As4BytesCapability value)
-
setBgpExtendedMessageCapability
public CParametersBuilder setBgpExtendedMessageCapability(BgpExtendedMessageCapability value)
-
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 CParameters build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<CParameters>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<CParameters,IllegalArgumentException>
-
-