Class As4GenericSpecExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.as._4.generic.spec.extended.community._case.As4GenericSpecExtendedCommunityBuilder
-
@Generated("mdsal-binding-generator") public class As4GenericSpecExtendedCommunityBuilder extends Object
Class that buildsAs4GenericSpecExtendedCommunity
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:
As4GenericSpecExtendedCommunity createAs4GenericSpecExtendedCommunity(int fooXyzzy, int barBaz) { return new As4GenericSpecExtendedCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of As4GenericSpecExtendedCommunity, 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:
As4GenericSpecExtendedCommunity
- 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 As4GenericSpecExtendedCommunityBuilder()
Construct an empty builder.As4GenericSpecExtendedCommunityBuilder(As4SpecCommon arg)
Construct a new builder initialized from specifiedAs4SpecCommon
.As4GenericSpecExtendedCommunityBuilder(As4GenericSpecExtendedCommunity base)
Construct a builder initialized with state from specifiedAs4GenericSpecExtendedCommunity
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description As4GenericSpecExtendedCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunity>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull As4GenericSpecExtendedCommunity
build()
A newAs4GenericSpecExtendedCommunity
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.As4SpecificCommon
getAs4SpecificCommon()
Return current value associated with the property corresponding toAs4SpecCommon.getAs4SpecificCommon()
.As4GenericSpecExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.As4GenericSpecExtendedCommunityBuilder
setAs4SpecificCommon(As4SpecificCommon value)
Set the property corresponding toAs4SpecCommon.getAs4SpecificCommon()
to the specified value.
-
-
-
Constructor Detail
-
As4GenericSpecExtendedCommunityBuilder
public As4GenericSpecExtendedCommunityBuilder()
Construct an empty builder.
-
As4GenericSpecExtendedCommunityBuilder
public As4GenericSpecExtendedCommunityBuilder(As4SpecCommon arg)
Construct a new builder initialized from specifiedAs4SpecCommon
.- Parameters:
arg
- As4SpecCommon from which the builder should be initialized
-
As4GenericSpecExtendedCommunityBuilder
public As4GenericSpecExtendedCommunityBuilder(As4GenericSpecExtendedCommunity base)
Construct a builder initialized with state from specifiedAs4GenericSpecExtendedCommunity
.- Parameters:
base
- As4GenericSpecExtendedCommunity 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
-
getAs4SpecificCommon
public As4SpecificCommon getAs4SpecificCommon()
Return current value associated with the property corresponding toAs4SpecCommon.getAs4SpecificCommon()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunity>> 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
-
setAs4SpecificCommon
public As4GenericSpecExtendedCommunityBuilder setAs4SpecificCommon(As4SpecificCommon value)
Set the property corresponding toAs4SpecCommon.getAs4SpecificCommon()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public As4GenericSpecExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunity> 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 As4GenericSpecExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<As4GenericSpecExtendedCommunity>> 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 As4GenericSpecExtendedCommunity build()
A newAs4GenericSpecExtendedCommunity
instance.- Returns:
- A new
As4GenericSpecExtendedCommunity
instance.
-
-