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
-
@Generated("mdsal-binding-generator") public class IsisTopologyAttributesBuilder extends Object
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
- 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 IsisTopologyAttributesBuilder()
Construct an empty builder.IsisTopologyAttributesBuilder(IsisTopologyAttributes base)
Construct a builder initialized with state from specifiedIsisTopologyAttributes
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull IsisTopologyAttributes
build()
A newIsisTopologyAttributes
instance.IsoNetId
getNet()
Return current value associated with the property corresponding toIsisTopologyAttributes.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)
Set the property corresponding toIsisTopologyAttributes.getNet()
to the specified value.
-
-
-
Constructor Detail
-
IsisTopologyAttributesBuilder
public IsisTopologyAttributesBuilder()
Construct an empty builder.
-
IsisTopologyAttributesBuilder
public IsisTopologyAttributesBuilder(IsisTopologyAttributes base)
Construct a builder initialized with state from specifiedIsisTopologyAttributes
.- Parameters:
base
- IsisTopologyAttributes from which the builder should be initialized
-
-
Method Detail
-
getNet
public IsoNetId getNet()
Return current value associated with the property corresponding toIsisTopologyAttributes.getNet()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IsisTopologyAttributes>> 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
-
setNet
public IsisTopologyAttributesBuilder setNet(IsoNetId value)
Set the property corresponding toIsisTopologyAttributes.getNet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull IsisTopologyAttributes build()
A newIsisTopologyAttributes
instance.- Returns:
- A new
IsisTopologyAttributes
instance.
-
-