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