Class IgpLinkAttributesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.link.attributes.IgpLinkAttributesBuilder
Class that builds
IgpLinkAttributes
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:
IgpLinkAttributes createIgpLinkAttributes(int fooXyzzy, int barBaz) {
return new IgpLinkAttributesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of IgpLinkAttributes, 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 specifiedIgpLinkAttributes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull IgpLinkAttributes
build()
A newIgpLinkAttributes
instance.static @NonNull IgpLinkAttributes
empty()
Get empty instance of IgpLinkAttributes.getFlag()
Return current value associated with the property corresponding toIgpLinkAttributes.getFlag()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toIgpLinkAttributes.getMetric()
.getName()
Return current value associated with the property corresponding toIgpLinkAttributes.getName()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>> augmentationType) Remove an augmentation from this builder's product.setFlag
(Set<FlagIdentity> values) Set the property corresponding toIgpLinkAttributes.getFlag()
to the specified value.setMetric
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toIgpLinkAttributes.getMetric()
to the specified value.Set the property corresponding toIgpLinkAttributes.getName()
to the specified value.
-
Constructor Details
-
IgpLinkAttributesBuilder
public IgpLinkAttributesBuilder()Construct an empty builder. -
IgpLinkAttributesBuilder
Construct a builder initialized with state from specifiedIgpLinkAttributes
.- Parameters:
base
- IgpLinkAttributes from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of IgpLinkAttributes.- Returns:
- An empty
IgpLinkAttributes
-
getFlag
Return current value associated with the property corresponding toIgpLinkAttributes.getFlag()
.- Returns:
- current value
-
getMetric
public org.opendaylight.yangtools.yang.common.Uint32 getMetric()Return current value associated with the property corresponding toIgpLinkAttributes.getMetric()
.- Returns:
- current value
-
getName
Return current value associated with the property corresponding toIgpLinkAttributes.getName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>> 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
-
setFlag
Set the property corresponding toIgpLinkAttributes.getFlag()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMetric
Set the property corresponding toIgpLinkAttributes.getMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
Set the property corresponding toIgpLinkAttributes.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IgpLinkAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes> 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 IgpLinkAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>> 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 newIgpLinkAttributes
instance.- Returns:
- A new
IgpLinkAttributes
instance.
-