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