Class As4GenericSpecExtendedCommunityCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.As4GenericSpecExtendedCommunityCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<As4GenericSpecExtendedCommunityCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<As4GenericSpecExtendedCommunityCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class As4GenericSpecExtendedCommunityCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<As4GenericSpecExtendedCommunityCase>
Class that buildsAs4GenericSpecExtendedCommunityCaseBuilder
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:
As4GenericSpecExtendedCommunityCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new As4GenericSpecExtendedCommunityCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of As4GenericSpecExtendedCommunityCaseBuilder, 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:
As4GenericSpecExtendedCommunityCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description As4GenericSpecExtendedCommunityCaseBuilder()
As4GenericSpecExtendedCommunityCaseBuilder(As4GenericSpecExtendedCommunityCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description As4GenericSpecExtendedCommunityCaseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.As4GenericSpecExtendedCommunityCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase>>
E$$augmentation(Class<E$$> augmentationType)
As4GenericSpecExtendedCommunityCase
build()
As4GenericSpecExtendedCommunity
getAs4GenericSpecExtendedCommunity()
As4GenericSpecExtendedCommunityCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase>> augmentationType)
Remove an augmentation from this builder's product.As4GenericSpecExtendedCommunityCaseBuilder
setAs4GenericSpecExtendedCommunity(As4GenericSpecExtendedCommunity value)
-
-
-
Constructor Detail
-
As4GenericSpecExtendedCommunityCaseBuilder
public As4GenericSpecExtendedCommunityCaseBuilder()
-
As4GenericSpecExtendedCommunityCaseBuilder
public As4GenericSpecExtendedCommunityCaseBuilder(As4GenericSpecExtendedCommunityCase base)
-
-
Method Detail
-
getAs4GenericSpecExtendedCommunity
public As4GenericSpecExtendedCommunity getAs4GenericSpecExtendedCommunity()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setAs4GenericSpecExtendedCommunity
public As4GenericSpecExtendedCommunityCaseBuilder setAs4GenericSpecExtendedCommunity(As4GenericSpecExtendedCommunity value)
-
addAugmentation
public As4GenericSpecExtendedCommunityCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.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
-
addAugmentation
@Deprecated(forRemoval=true) public As4GenericSpecExtendedCommunityCaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunityCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public As4GenericSpecExtendedCommunityCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.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
public As4GenericSpecExtendedCommunityCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<As4GenericSpecExtendedCommunityCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<As4GenericSpecExtendedCommunityCase,IllegalArgumentException>
-
-