Class IsisNodeAttributesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.isis.topology.rev131021.isis.node.attributes.IsisNodeAttributesBuilder
Class that builds
IsisNodeAttributes
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:
IsisNodeAttributes createIsisNodeAttributes(int fooXyzzy, int barBaz) {
return new IsisNodeAttributesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of IsisNodeAttributes, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedIsisNodeAttributes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<IsisNodeAttributes> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IsisNodeAttributes>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull IsisNodeAttributes
build()
A newIsisNodeAttributes
instance.static @NonNull IsisNodeAttributes
empty()
Get empty instance of IsisNodeAttributes.getIso()
Return current value associated with the property corresponding toIsisNodeAttributes.getIso()
.Set<org.opendaylight.yangtools.yang.common.Uint8>
Return current value associated with the property corresponding toIsisNodeAttributes.getMultiTopologyId()
.getNet()
Return current value associated with the property corresponding toIsisNodeAttributes.getNet()
.Return current value associated with the property corresponding toIsisNodeAttributes.getRouterType()
.getTed()
Return current value associated with the property corresponding toIsisNodeAttributes.getTed()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IsisNodeAttributes>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toIsisNodeAttributes.getIso()
to the specified value.setMultiTopologyId
(Set<org.opendaylight.yangtools.yang.common.Uint8> values) Set the property corresponding toIsisNodeAttributes.getMultiTopologyId()
to the specified value.Set the property corresponding toIsisNodeAttributes.getNet()
to the specified value.setRouterType
(RouterType value) Set the property corresponding toIsisNodeAttributes.getRouterType()
to the specified value.Set the property corresponding toIsisNodeAttributes.getTed()
to the specified value.
-
Constructor Details
-
IsisNodeAttributesBuilder
public IsisNodeAttributesBuilder()Construct an empty builder. -
IsisNodeAttributesBuilder
Construct a builder initialized with state from specifiedIsisNodeAttributes
.- Parameters:
base
- IsisNodeAttributes from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of IsisNodeAttributes.- Returns:
- An empty
IsisNodeAttributes
-
getIso
Return current value associated with the property corresponding toIsisNodeAttributes.getIso()
.- Returns:
- current value
-
getMultiTopologyId
Return current value associated with the property corresponding toIsisNodeAttributes.getMultiTopologyId()
.- Returns:
- current value
-
getNet
Return current value associated with the property corresponding toIsisNodeAttributes.getNet()
.- Returns:
- current value
-
getRouterType
Return current value associated with the property corresponding toIsisNodeAttributes.getRouterType()
.- Returns:
- current value
-
getTed
Return current value associated with the property corresponding toIsisNodeAttributes.getTed()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IsisNodeAttributes>> 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
-
setIso
Set the property corresponding toIsisNodeAttributes.getIso()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMultiTopologyId
public IsisNodeAttributesBuilder setMultiTopologyId(Set<org.opendaylight.yangtools.yang.common.Uint8> values) Set the property corresponding toIsisNodeAttributes.getMultiTopologyId()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setNet
Set the property corresponding toIsisNodeAttributes.getNet()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setRouterType
Set the property corresponding toIsisNodeAttributes.getRouterType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTed
Set the property corresponding toIsisNodeAttributes.getTed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IsisNodeAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IsisNodeAttributes> 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 IsisNodeAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IsisNodeAttributes>> 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
A newIsisNodeAttributes
instance.- Returns:
- A new
IsisNodeAttributes
instance.
-