Class ExtCommunitySetBuilder
- 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.ExtCommunitySetBuilder
-
@Generated("mdsal-binding-generator") public class ExtCommunitySetBuilder extends Object
Class that buildsExtCommunitySet
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:
ExtCommunitySet createExtCommunitySet(int fooXyzzy, int barBaz) { return new ExtCommunitySetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExtCommunitySet, 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:
ExtCommunitySet
- 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 ExtCommunitySetBuilder()
Construct an empty builder.ExtCommunitySetBuilder(ExtCommunitySet base)
Construct a builder initialized with state from specifiedExtCommunitySet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExtCommunitySetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunitySet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunitySet>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ExtCommunitySet
build()
A newExtCommunitySet
instance.List<ExtCommunityMember>
getExtCommunityMember()
Return current value associated with the property corresponding toExtCommunitySet.getExtCommunityMember()
.String
getExtCommunitySetName()
Return current value associated with the property corresponding toExtCommunitySet.getExtCommunitySetName()
.ExtCommunitySetKey
key()
Return current value associated with the property corresponding toExtCommunitySet.key()
.ExtCommunitySetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunitySet>> augmentationType)
Remove an augmentation from this builder's product.ExtCommunitySetBuilder
setExtCommunityMember(List<ExtCommunityMember> values)
Set the property corresponding toExtCommunitySet.getExtCommunityMember()
to the specified value.ExtCommunitySetBuilder
setExtCommunitySetName(String value)
Set the property corresponding toExtCommunitySet.getExtCommunitySetName()
to the specified value.ExtCommunitySetBuilder
withKey(ExtCommunitySetKey key)
-
-
-
Constructor Detail
-
ExtCommunitySetBuilder
public ExtCommunitySetBuilder()
Construct an empty builder.
-
ExtCommunitySetBuilder
public ExtCommunitySetBuilder(ExtCommunitySet base)
Construct a builder initialized with state from specifiedExtCommunitySet
.- Parameters:
base
- ExtCommunitySet from which the builder should be initialized
-
-
Method Detail
-
key
public ExtCommunitySetKey key()
Return current value associated with the property corresponding toExtCommunitySet.key()
.- Returns:
- current value
-
getExtCommunityMember
public List<ExtCommunityMember> getExtCommunityMember()
Return current value associated with the property corresponding toExtCommunitySet.getExtCommunityMember()
.- Returns:
- current value
-
getExtCommunitySetName
public String getExtCommunitySetName()
Return current value associated with the property corresponding toExtCommunitySet.getExtCommunitySetName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunitySet>> 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
-
withKey
public ExtCommunitySetBuilder withKey(ExtCommunitySetKey key)
-
setExtCommunityMember
public ExtCommunitySetBuilder setExtCommunityMember(List<ExtCommunityMember> values)
Set the property corresponding toExtCommunitySet.getExtCommunityMember()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setExtCommunitySetName
public ExtCommunitySetBuilder setExtCommunitySetName(String value)
Set the property corresponding toExtCommunitySet.getExtCommunitySetName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ExtCommunitySetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunitySet> 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 ExtCommunitySetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunitySet>> 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 ExtCommunitySet build()
A newExtCommunitySet
instance.- Returns:
- A new
ExtCommunitySet
instance.
-
-