Class As4GenericSpecExtendedCommunityCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.As4GenericSpecExtendedCommunityCaseBuilder
@Generated("mdsal-binding-generator")
public class As4GenericSpecExtendedCommunityCaseBuilder
extends Object
Class that builds
As4GenericSpecExtendedCommunityCase
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:
As4GenericSpecExtendedCommunityCase createAs4GenericSpecExtendedCommunityCase(int fooXyzzy, int barBaz) {
return new As4GenericSpecExtendedCommunityCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of As4GenericSpecExtendedCommunityCase, 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 builder initialized with state from specifiedAs4GenericSpecExtendedCommunityCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<As4GenericSpecExtendedCommunityCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<As4GenericSpecExtendedCommunityCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull As4GenericSpecExtendedCommunityCase
build()
A newAs4GenericSpecExtendedCommunityCase
instance.Return current value associated with the property corresponding toAs4GenericSpecExtendedCommunityCase.getAs4GenericSpecExtendedCommunity()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<As4GenericSpecExtendedCommunityCase>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toAs4GenericSpecExtendedCommunityCase.getAs4GenericSpecExtendedCommunity()
to the specified value.
-
Constructor Details
-
As4GenericSpecExtendedCommunityCaseBuilder
public As4GenericSpecExtendedCommunityCaseBuilder()Construct an empty builder. -
As4GenericSpecExtendedCommunityCaseBuilder
Construct a builder initialized with state from specifiedAs4GenericSpecExtendedCommunityCase
.- Parameters:
base
- As4GenericSpecExtendedCommunityCase from which the builder should be initialized
-
-
Method Details
-
getAs4GenericSpecExtendedCommunity
Return current value associated with the property corresponding toAs4GenericSpecExtendedCommunityCase.getAs4GenericSpecExtendedCommunity()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<As4GenericSpecExtendedCommunityCase>> 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
-
setAs4GenericSpecExtendedCommunity
public As4GenericSpecExtendedCommunityCaseBuilder setAs4GenericSpecExtendedCommunity(As4GenericSpecExtendedCommunity value) Set the property corresponding toAs4GenericSpecExtendedCommunityCase.getAs4GenericSpecExtendedCommunity()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public As4GenericSpecExtendedCommunityCaseBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<As4GenericSpecExtendedCommunityCase> 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 As4GenericSpecExtendedCommunityCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<As4GenericSpecExtendedCommunityCase>> 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
A newAs4GenericSpecExtendedCommunityCase
instance.- Returns:
- A new
As4GenericSpecExtendedCommunityCase
instance.
-