Class AdjacencyBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.sr.rev130819.sr.node.attributes.segments.segment.specification.adjacency._case.AdjacencyBuilder
Class that builds
Adjacency
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:
Adjacency createAdjacency(int fooXyzzy, int barBaz) {
return new AdjacencyBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Adjacency, 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.AdjacencyBuilder
(Adjacency base) Construct a builder initialized with state from specifiedAdjacency
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Adjacency
build()
A newAdjacency
instance.static @NonNull Adjacency
empty()
Get empty instance of Adjacency.org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId
Return current value associated with the property corresponding toAdjacency.getAdjacency()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>> augmentationType) Remove an augmentation from this builder's product.setAdjacency
(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value) Set the property corresponding toAdjacency.getAdjacency()
to the specified value.
-
Constructor Details
-
AdjacencyBuilder
public AdjacencyBuilder()Construct an empty builder. -
AdjacencyBuilder
Construct a builder initialized with state from specifiedAdjacency
.- Parameters:
base
- Adjacency from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Adjacency.- Returns:
- An empty
Adjacency
-
getAdjacency
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getAdjacency()Return current value associated with the property corresponding toAdjacency.getAdjacency()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>> 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
-
setAdjacency
public AdjacencyBuilder setAdjacency(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value) Set the property corresponding toAdjacency.getAdjacency()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AdjacencyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency> 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 AdjacencyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>> 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 newAdjacency
instance.- Returns:
- A new
Adjacency
instance.
-