Class SourceAs4ExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.source.as._4.extended.community._case.SourceAs4ExtendedCommunityBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SourceAs4ExtendedCommunity>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SourceAs4ExtendedCommunity,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SourceAs4ExtendedCommunityBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SourceAs4ExtendedCommunity>
Class that buildsSourceAs4ExtendedCommunity
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:
SourceAs4ExtendedCommunity createSourceAs4ExtendedCommunity(int fooXyzzy, int barBaz) { return new SourceAs4ExtendedCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SourceAs4ExtendedCommunity, 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:
SourceAs4ExtendedCommunity
,Builder
-
-
Constructor Summary
Constructors Constructor Description SourceAs4ExtendedCommunityBuilder()
SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunity base)
SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunityGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SourceAs4ExtendedCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>>
E$$augmentation(Class<E$$> augmentationType)
SourceAs4ExtendedCommunity
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getGlobalAdministrator()
SourceAs4ExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.SourceAs4ExtendedCommunityBuilder
setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
-
-
Constructor Detail
-
SourceAs4ExtendedCommunityBuilder
public SourceAs4ExtendedCommunityBuilder()
-
SourceAs4ExtendedCommunityBuilder
public SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunityGrouping arg)
-
SourceAs4ExtendedCommunityBuilder
public SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunity base)
-
-
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:- SourceAs4ExtendedCommunityGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getGlobalAdministrator
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getGlobalAdministrator()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>> E$$ augmentation(Class<E$$> augmentationType)
-
setGlobalAdministrator
public SourceAs4ExtendedCommunityBuilder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
addAugmentation
public SourceAs4ExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity> 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 SourceAs4ExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>> 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 SourceAs4ExtendedCommunity build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SourceAs4ExtendedCommunity>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SourceAs4ExtendedCommunity,IllegalArgumentException>
-
-