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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AsPathSet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AsPathSet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AsPathSetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AsPathSet>
Class that buildsAsPathSetBuilder
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:
AsPathSetBuilder createTarget(int fooXyzzy, int barBaz) { return new AsPathSetBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AsPathSetBuilder, 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 oportunities, 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:
AsPathSetBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AsPathSetBuilder()
AsPathSetBuilder(AsPathSet base)
-
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)
AsPathSet
build()
List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber>
getAsPathSetMember()
String
getAsPathSetName()
AsPathSetKey
key()
AsPathSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet>> augmentationType)
Remove an augmentation from this builder's product.AsPathSetBuilder
setAsPathSetMember(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> values)
AsPathSetBuilder
setAsPathSetName(String value)
AsPathSetBuilder
withKey(AsPathSetKey key)
-
-
-
Constructor Detail
-
AsPathSetBuilder
public AsPathSetBuilder()
-
AsPathSetBuilder
public AsPathSetBuilder(AsPathSet base)
-
-
Method Detail
-
key
public AsPathSetKey key()
-
getAsPathSetMember
public List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> getAsPathSetMember()
-
getAsPathSetName
public String getAsPathSetName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathSet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public AsPathSetBuilder withKey(AsPathSetKey key)
-
setAsPathSetMember
public AsPathSetBuilder setAsPathSetMember(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> values)
-
setAsPathSetName
public AsPathSetBuilder setAsPathSetName(String value)
-
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
-
build
public AsPathSet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AsPathSet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AsPathSet,IllegalArgumentException>
-
-