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
-
@Generated("mdsal-binding-generator") public class SetCommunityBuilder extends Object
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
- 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 SetCommunityBuilder()
Construct an empty builder.SetCommunityBuilder(SetCommunity base)
Construct a builder initialized with state from specifiedSetCommunity
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull SetCommunity
build()
A newSetCommunity
instance.BgpSetCommunityOptionType
getOptions()
Return current value associated with the property corresponding toSetCommunity.getOptions()
.SetCommunityMethod
getSetCommunityMethod()
Return current value associated with the property corresponding toSetCommunity.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)
Set the property corresponding toSetCommunity.getOptions()
to the specified value.SetCommunityBuilder
setSetCommunityMethod(SetCommunityMethod value)
Set the property corresponding toSetCommunity.getSetCommunityMethod()
to the specified value.
-
-
-
Constructor Detail
-
SetCommunityBuilder
public SetCommunityBuilder()
Construct an empty builder.
-
SetCommunityBuilder
public SetCommunityBuilder(SetCommunity base)
Construct a builder initialized with state from specifiedSetCommunity
.- Parameters:
base
- SetCommunity from which the builder should be initialized
-
-
Method Detail
-
getOptions
public BgpSetCommunityOptionType getOptions()
Return current value associated with the property corresponding toSetCommunity.getOptions()
.- Returns:
- current value
-
getSetCommunityMethod
public SetCommunityMethod getSetCommunityMethod()
Return current value associated with the property corresponding toSetCommunity.getSetCommunityMethod()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetCommunity>> 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
-
setOptions
public SetCommunityBuilder setOptions(BgpSetCommunityOptionType value)
Set the property corresponding toSetCommunity.getOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSetCommunityMethod
public SetCommunityBuilder setSetCommunityMethod(SetCommunityMethod value)
Set the property corresponding toSetCommunity.getSetCommunityMethod()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull SetCommunity build()
A newSetCommunity
instance.- Returns:
- A new
SetCommunity
instance.
-
-