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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExtCommunitySet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExtCommunitySet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExtCommunitySetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ExtCommunitySet>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExtCommunitySetBuilder()
ExtCommunitySetBuilder(ExtCommunitySet base)
-
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)
ExtCommunitySet
build()
List<ExtCommunityMember>
getExtCommunityMember()
String
getExtCommunitySetName()
ExtCommunitySetKey
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)
ExtCommunitySetBuilder
setExtCommunitySetName(String value)
ExtCommunitySetBuilder
withKey(ExtCommunitySetKey key)
-
-
-
Constructor Detail
-
ExtCommunitySetBuilder
public ExtCommunitySetBuilder()
-
ExtCommunitySetBuilder
public ExtCommunitySetBuilder(ExtCommunitySet base)
-
-
Method Detail
-
key
public ExtCommunitySetKey key()
-
getExtCommunityMember
public List<ExtCommunityMember> getExtCommunityMember()
-
getExtCommunitySetName
public String getExtCommunitySetName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExtCommunitySet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ExtCommunitySetBuilder withKey(ExtCommunitySetKey key)
-
setExtCommunityMember
public ExtCommunitySetBuilder setExtCommunityMember(List<ExtCommunityMember> values)
-
setExtCommunitySetName
public ExtCommunitySetBuilder setExtCommunitySetName(String value)
-
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 ExtCommunitySet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExtCommunitySet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExtCommunitySet,IllegalArgumentException>
-
-