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