Class ClusterIdSetsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.bgp.cluster.id.sets.ClusterIdSetsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ClusterIdSets>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ClusterIdSets,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ClusterIdSetsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ClusterIdSets>
Class that buildsClusterIdSets
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:
ClusterIdSets createClusterIdSets(int fooXyzzy, int barBaz) { return new ClusterIdSetsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ClusterIdSets, 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:
ClusterIdSets
,Builder
-
-
Constructor Summary
Constructors Constructor Description ClusterIdSetsBuilder()
ClusterIdSetsBuilder(ClusterIdSets base)
ClusterIdSetsBuilder(ClusterIdSet arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClusterIdSetsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSets> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSets>>
E$$augmentation(Class<E$$> augmentationType)
ClusterIdSets
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<ClusterIdSetKey,ClusterIdSet>
getClusterIdSet()
ClusterIdSetsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSets>> augmentationType)
Remove an augmentation from this builder's product.ClusterIdSetsBuilder
setClusterIdSet(Map<ClusterIdSetKey,ClusterIdSet> values)
-
-
-
Constructor Detail
-
ClusterIdSetsBuilder
public ClusterIdSetsBuilder()
-
ClusterIdSetsBuilder
public ClusterIdSetsBuilder(ClusterIdSet arg)
-
ClusterIdSetsBuilder
public ClusterIdSetsBuilder(ClusterIdSets base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.ClusterIdSet
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getClusterIdSet
public Map<ClusterIdSetKey,ClusterIdSet> getClusterIdSet()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSets>> E$$ augmentation(Class<E$$> augmentationType)
-
setClusterIdSet
public ClusterIdSetsBuilder setClusterIdSet(Map<ClusterIdSetKey,ClusterIdSet> values)
-
addAugmentation
public ClusterIdSetsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSets> 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 ClusterIdSetsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClusterIdSets>> 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 ClusterIdSets build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ClusterIdSets>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ClusterIdSets,IllegalArgumentException>
-
-