Class AsbrBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.ospf.node.attributes.router.type.AsbrBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Asbr>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Asbr,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AsbrBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Asbr>
Class that buildsAsbr
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:
Asbr createAsbr(int fooXyzzy, int barBaz) { return new AsbrBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Asbr, 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:
Asbr
,Builder
-
-
Constructor Summary
Constructors Constructor Description AsbrBuilder()
AsbrBuilder(Asbr base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AsbrBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Asbr> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Asbr>>
E$$augmentation(Class<E$$> augmentationType)
Asbr
build()
org.opendaylight.yangtools.yang.common.Empty
getAsbr()
AsbrBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Asbr>> augmentationType)
Remove an augmentation from this builder's product.AsbrBuilder
setAsbr(org.opendaylight.yangtools.yang.common.Empty value)
-
-
-
Constructor Detail
-
AsbrBuilder
public AsbrBuilder()
-
AsbrBuilder
public AsbrBuilder(Asbr base)
-
-
Method Detail
-
getAsbr
public org.opendaylight.yangtools.yang.common.Empty getAsbr()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Asbr>> E$$ augmentation(Class<E$$> augmentationType)
-
setAsbr
public AsbrBuilder setAsbr(org.opendaylight.yangtools.yang.common.Empty value)
-
addAugmentation
public AsbrBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Asbr> 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 AsbrBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Asbr>> 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 Asbr build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Asbr>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Asbr,IllegalArgumentException>
-
-