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
-
@Generated("mdsal-binding-generator") public class ClusterIdSetBuilder extends Object
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
- 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 ClusterIdSetBuilder()
Construct an empty builder.ClusterIdSetBuilder(ClusterIdSet base)
Construct a builder initialized with state from specifiedClusterIdSet
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull ClusterIdSet
build()
A newClusterIdSet
instance.Set<ClusterIdentifier>
getClusterId()
Return current value associated with the property corresponding toClusterIdSet.getClusterId()
.String
getClusterIdSetName()
Return current value associated with the property corresponding toClusterIdSet.getClusterIdSetName()
.Local
getLocal()
Return current value associated with the property corresponding toClusterIdSet.getLocal()
.ClusterIdSetKey
key()
Return current value associated with the property corresponding toClusterIdSet.key()
.ClusterIdSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet>> augmentationType)
Remove an augmentation from this builder's product.ClusterIdSetBuilder
setClusterId(Set<ClusterIdentifier> values)
Set the property corresponding toClusterIdSet.getClusterId()
to the specified value.ClusterIdSetBuilder
setClusterIdSetName(String value)
Set the property corresponding toClusterIdSet.getClusterIdSetName()
to the specified value.ClusterIdSetBuilder
setLocal(Local value)
Set the property corresponding toClusterIdSet.getLocal()
to the specified value.ClusterIdSetBuilder
withKey(ClusterIdSetKey key)
-
-
-
Constructor Detail
-
ClusterIdSetBuilder
public ClusterIdSetBuilder()
Construct an empty builder.
-
ClusterIdSetBuilder
public ClusterIdSetBuilder(ClusterIdSet base)
Construct a builder initialized with state from specifiedClusterIdSet
.- Parameters:
base
- ClusterIdSet from which the builder should be initialized
-
-
Method Detail
-
key
public ClusterIdSetKey key()
Return current value associated with the property corresponding toClusterIdSet.key()
.- Returns:
- current value
-
getClusterId
public Set<ClusterIdentifier> getClusterId()
Return current value associated with the property corresponding toClusterIdSet.getClusterId()
.- Returns:
- current value
-
getClusterIdSetName
public String getClusterIdSetName()
Return current value associated with the property corresponding toClusterIdSet.getClusterIdSetName()
.- Returns:
- current value
-
getLocal
public Local getLocal()
Return current value associated with the property corresponding toClusterIdSet.getLocal()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSet>> 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 ClusterIdSetBuilder withKey(ClusterIdSetKey key)
-
setClusterId
public ClusterIdSetBuilder setClusterId(Set<ClusterIdentifier> values)
Set the property corresponding toClusterIdSet.getClusterId()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setClusterIdSetName
public ClusterIdSetBuilder setClusterIdSetName(String value)
Set the property corresponding toClusterIdSet.getClusterIdSetName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocal
public ClusterIdSetBuilder setLocal(Local value)
Set the property corresponding toClusterIdSet.getLocal()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull ClusterIdSet build()
A newClusterIdSet
instance.- Returns:
- A new
ClusterIdSet
instance.
-
-