Class MultiprotocolCapabilityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder
-
@Generated("mdsal-binding-generator") public class MultiprotocolCapabilityBuilder extends Object
Class that buildsMultiprotocolCapability
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:
MultiprotocolCapability createMultiprotocolCapability(int fooXyzzy, int barBaz) { return new MultiprotocolCapabilityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultiprotocolCapability, 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:
MultiprotocolCapability
- 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 MultiprotocolCapabilityBuilder()
Construct an empty builder.MultiprotocolCapabilityBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.MultiprotocolCapabilityBuilder(MultiprotocolCapability base)
Construct a builder initialized with state from specifiedMultiprotocolCapability
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MultiprotocolCapabilityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultiprotocolCapability> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultiprotocolCapability>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MultiprotocolCapability
build()
A newMultiprotocolCapability
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends AddressFamily>
getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.Class<? extends SubsequentAddressFamily>
getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.MultiprotocolCapabilityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultiprotocolCapability>> augmentationType)
Remove an augmentation from this builder's product.MultiprotocolCapabilityBuilder
setAfi(Class<? extends AddressFamily> value)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.MultiprotocolCapabilityBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.
-
-
-
Constructor Detail
-
MultiprotocolCapabilityBuilder
public MultiprotocolCapabilityBuilder()
Construct an empty builder.
-
MultiprotocolCapabilityBuilder
public MultiprotocolCapabilityBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.- Parameters:
arg
- BgpTableType from which the builder should be initialized
-
MultiprotocolCapabilityBuilder
public MultiprotocolCapabilityBuilder(MultiprotocolCapability base)
Construct a builder initialized with state from specifiedMultiprotocolCapability
.- Parameters:
base
- MultiprotocolCapability 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
-
getAfi
public Class<? extends AddressFamily> getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.- Returns:
- current value
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultiprotocolCapability>> 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
-
setAfi
public MultiprotocolCapabilityBuilder setAfi(Class<? extends AddressFamily> value)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSafi
public MultiprotocolCapabilityBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MultiprotocolCapabilityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultiprotocolCapability> 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 MultiprotocolCapabilityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultiprotocolCapability>> 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 MultiprotocolCapability build()
A newMultiprotocolCapability
instance.- Returns:
- A new
MultiprotocolCapability
instance.
-
-