Class SetCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.policy.definitions.policy.definition.statements.statement.actions.bgp.actions.SetCommunityBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SetCommunity>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SetCommunity,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SetCommunityBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SetCommunity>
Class that buildsSetCommunity
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:
SetCommunity createSetCommunity(int fooXyzzy, int barBaz) { return new SetCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetCommunity, 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:
SetCommunity
,Builder
-
-
Constructor Summary
Constructors Constructor Description SetCommunityBuilder()
SetCommunityBuilder(SetCommunity base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetCommunity>>
E$$augmentation(Class<E$$> augmentationType)
SetCommunity
build()
BgpSetCommunityOptionType
getOptions()
SetCommunityMethod
getSetCommunityMethod()
SetCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetCommunity>> augmentationType)
Remove an augmentation from this builder's product.SetCommunityBuilder
setOptions(BgpSetCommunityOptionType value)
SetCommunityBuilder
setSetCommunityMethod(SetCommunityMethod value)
-
-
-
Constructor Detail
-
SetCommunityBuilder
public SetCommunityBuilder()
-
SetCommunityBuilder
public SetCommunityBuilder(SetCommunity base)
-
-
Method Detail
-
getOptions
public BgpSetCommunityOptionType getOptions()
-
getSetCommunityMethod
public SetCommunityMethod getSetCommunityMethod()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetCommunity>> E$$ augmentation(Class<E$$> augmentationType)
-
setOptions
public SetCommunityBuilder setOptions(BgpSetCommunityOptionType value)
-
setSetCommunityMethod
public SetCommunityBuilder setSetCommunityMethod(SetCommunityMethod value)
-
addAugmentation
public SetCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetCommunity> 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 SetCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetCommunity>> 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 SetCommunity build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SetCommunity>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SetCommunity,IllegalArgumentException>
-
-