Class AsPathSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.bgp.defined.sets.as.path.sets.AsPathSetBuilder
-
@Generated("mdsal-binding-generator") public class AsPathSetBuilder extends Object
Class that buildsAsPathSet
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:
AsPathSet createAsPathSet(int fooXyzzy, int barBaz) { return new AsPathSetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AsPathSet, 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:
AsPathSet
- 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 AsPathSetBuilder()
Construct an empty builder.AsPathSetBuilder(AsPathSet base)
Construct a builder initialized with state from specifiedAsPathSet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AsPathSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull AsPathSet
build()
A newAsPathSet
instance.Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber>
getAsPathSetMember()
Return current value associated with the property corresponding toAsPathSet.getAsPathSetMember()
.String
getAsPathSetName()
Return current value associated with the property corresponding toAsPathSet.getAsPathSetName()
.AsPathSetKey
key()
Return current value associated with the property corresponding toAsPathSet.key()
.AsPathSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet>> augmentationType)
Remove an augmentation from this builder's product.AsPathSetBuilder
setAsPathSetMember(Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> values)
Set the property corresponding toAsPathSet.getAsPathSetMember()
to the specified value.AsPathSetBuilder
setAsPathSetName(String value)
Set the property corresponding toAsPathSet.getAsPathSetName()
to the specified value.AsPathSetBuilder
withKey(AsPathSetKey key)
-
-
-
Method Detail
-
key
public AsPathSetKey key()
Return current value associated with the property corresponding toAsPathSet.key()
.- Returns:
- current value
-
getAsPathSetMember
public Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> getAsPathSetMember()
Return current value associated with the property corresponding toAsPathSet.getAsPathSetMember()
.- Returns:
- current value
-
getAsPathSetName
public String getAsPathSetName()
Return current value associated with the property corresponding toAsPathSet.getAsPathSetName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet>> 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 AsPathSetBuilder withKey(AsPathSetKey key)
-
setAsPathSetMember
public AsPathSetBuilder setAsPathSetMember(Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> values)
Set the property corresponding toAsPathSet.getAsPathSetMember()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setAsPathSetName
public AsPathSetBuilder setAsPathSetName(String value)
Set the property corresponding toAsPathSet.getAsPathSetName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AsPathSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet> 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 AsPathSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet>> 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
-
-