Class ClusterIdSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.cluster.id.set.ClusterIdSetBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ClusterIdSet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ClusterIdSet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ClusterIdSetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ClusterIdSet>
Class that buildsClusterIdSet
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:
ClusterIdSet createClusterIdSet(int fooXyzzy, int barBaz) { return new ClusterIdSetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ClusterIdSet, 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:
ClusterIdSet
,Builder
-
-
Constructor Summary
Constructors Constructor Description ClusterIdSetBuilder()
ClusterIdSetBuilder(ClusterIdSet base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClusterIdSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet>>
E$$augmentation(Class<E$$> augmentationType)
ClusterIdSet
build()
List<ClusterIdentifier>
getClusterId()
String
getClusterIdSetName()
Local
getLocal()
ClusterIdSetKey
key()
ClusterIdSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet>> augmentationType)
Remove an augmentation from this builder's product.ClusterIdSetBuilder
setClusterId(List<ClusterIdentifier> values)
ClusterIdSetBuilder
setClusterIdSetName(String value)
ClusterIdSetBuilder
setLocal(Local value)
ClusterIdSetBuilder
withKey(ClusterIdSetKey key)
-
-
-
Constructor Detail
-
ClusterIdSetBuilder
public ClusterIdSetBuilder()
-
ClusterIdSetBuilder
public ClusterIdSetBuilder(ClusterIdSet base)
-
-
Method Detail
-
key
public ClusterIdSetKey key()
-
getClusterId
public List<ClusterIdentifier> getClusterId()
-
getClusterIdSetName
public String getClusterIdSetName()
-
getLocal
public Local getLocal()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ClusterIdSetBuilder withKey(ClusterIdSetKey key)
-
setClusterId
public ClusterIdSetBuilder setClusterId(List<ClusterIdentifier> values)
-
setClusterIdSetName
public ClusterIdSetBuilder setClusterIdSetName(String value)
-
setLocal
public ClusterIdSetBuilder setLocal(Local value)
-
addAugmentation
public ClusterIdSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet> 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 ClusterIdSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet>> 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 ClusterIdSet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ClusterIdSet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ClusterIdSet,IllegalArgumentException>
-
-