Class BgpDefinedSetsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.BgpDefinedSetsBuilder
-
@Generated("mdsal-binding-generator") public class BgpDefinedSetsBuilder extends Object
Class that buildsBgpDefinedSets
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:
BgpDefinedSets createBgpDefinedSets(int fooXyzzy, int barBaz) { return new BgpDefinedSetsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpDefinedSets, 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:
BgpDefinedSets
- 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 BgpDefinedSetsBuilder()
Construct an empty builder.BgpDefinedSetsBuilder(BgpDefinedSets base)
Construct a builder initialized with state from specifiedBgpDefinedSets
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BgpDefinedSetsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpDefinedSets> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpDefinedSets>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BgpDefinedSets
build()
A newBgpDefinedSets
instance.AsPathSets
getAsPathSets()
Return current value associated with the property corresponding toBgpDefinedSets.getAsPathSets()
.CommunitySets
getCommunitySets()
Return current value associated with the property corresponding toBgpDefinedSets.getCommunitySets()
.ExtCommunitySets
getExtCommunitySets()
Return current value associated with the property corresponding toBgpDefinedSets.getExtCommunitySets()
.BgpDefinedSetsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpDefinedSets>> augmentationType)
Remove an augmentation from this builder's product.BgpDefinedSetsBuilder
setAsPathSets(AsPathSets value)
Set the property corresponding toBgpDefinedSets.getAsPathSets()
to the specified value.BgpDefinedSetsBuilder
setCommunitySets(CommunitySets value)
Set the property corresponding toBgpDefinedSets.getCommunitySets()
to the specified value.BgpDefinedSetsBuilder
setExtCommunitySets(ExtCommunitySets value)
Set the property corresponding toBgpDefinedSets.getExtCommunitySets()
to the specified value.
-
-
-
Constructor Detail
-
BgpDefinedSetsBuilder
public BgpDefinedSetsBuilder()
Construct an empty builder.
-
BgpDefinedSetsBuilder
public BgpDefinedSetsBuilder(BgpDefinedSets base)
Construct a builder initialized with state from specifiedBgpDefinedSets
.- Parameters:
base
- BgpDefinedSets from which the builder should be initialized
-
-
Method Detail
-
getAsPathSets
public AsPathSets getAsPathSets()
Return current value associated with the property corresponding toBgpDefinedSets.getAsPathSets()
.- Returns:
- current value
-
getCommunitySets
public CommunitySets getCommunitySets()
Return current value associated with the property corresponding toBgpDefinedSets.getCommunitySets()
.- Returns:
- current value
-
getExtCommunitySets
public ExtCommunitySets getExtCommunitySets()
Return current value associated with the property corresponding toBgpDefinedSets.getExtCommunitySets()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpDefinedSets>> 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
-
setAsPathSets
public BgpDefinedSetsBuilder setAsPathSets(AsPathSets value)
Set the property corresponding toBgpDefinedSets.getAsPathSets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCommunitySets
public BgpDefinedSetsBuilder setCommunitySets(CommunitySets value)
Set the property corresponding toBgpDefinedSets.getCommunitySets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExtCommunitySets
public BgpDefinedSetsBuilder setExtCommunitySets(ExtCommunitySets value)
Set the property corresponding toBgpDefinedSets.getExtCommunitySets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BgpDefinedSetsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpDefinedSets> 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 BgpDefinedSetsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpDefinedSets>> 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 BgpDefinedSets build()
A newBgpDefinedSets
instance.- Returns:
- A new
BgpDefinedSets
instance.
-
-