Class ExtCommunityMemberBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.bgp.defined.sets.ext.community.sets.ext.community.set.ExtCommunityMemberBuilder
Class that builds
ExtCommunityMember
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:
ExtCommunityMember createExtCommunityMember(int fooXyzzy, int barBaz) {
return new ExtCommunityMemberBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ExtCommunityMember, 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 specifiedExtCommunityMember
.Construct a new builder initialized from specifiedExtendedCommunity
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunityMember> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunityMember>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ExtCommunityMember
build()
A newExtCommunityMember
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toExtendedCommunity.getExtendedCommunity()
.Return current value associated with the property corresponding toExtendedCommunity.getTransitive()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunityMember>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toExtendedCommunity.getExtendedCommunity()
to the specified value.setTransitive
(Boolean value) Set the property corresponding toExtendedCommunity.getTransitive()
to the specified value.
-
Constructor Details
-
ExtCommunityMemberBuilder
public ExtCommunityMemberBuilder()Construct an empty builder. -
ExtCommunityMemberBuilder
Construct a new builder initialized from specifiedExtendedCommunity
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.ExtendedCommunity from which the builder should be initialized
-
ExtCommunityMemberBuilder
Construct a builder initialized with state from specifiedExtCommunityMember
.- Parameters:
base
- ExtCommunityMember from which the builder should be initialized
-
-
Method Details
-
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
-
getExtendedCommunity
Return current value associated with the property corresponding toExtendedCommunity.getExtendedCommunity()
.- Returns:
- current value
-
getTransitive
Return current value associated with the property corresponding toExtendedCommunity.getTransitive()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunityMember>> 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
-
setExtendedCommunity
Set the property corresponding toExtendedCommunity.getExtendedCommunity()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransitive
Set the property corresponding toExtendedCommunity.getTransitive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ExtCommunityMemberBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunityMember> 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 ExtCommunityMemberBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunityMember>> 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 newExtCommunityMember
instance.- Returns:
- A new
ExtCommunityMember
instance.
-