Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.graph.topology
Class GraphBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.graph.topology.GraphBuilder
-
@Generated("mdsal-binding-generator") public class GraphBuilder extends Object
Class that buildsGraph
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:
Graph createGraph(int fooXyzzy, int barBaz) { return new GraphBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Graph, 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:
Graph
- 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 GraphBuilder()
Construct an empty builder.GraphBuilder(Graph base)
Construct a builder initialized with state from specifiedGraph
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GraphBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Graph> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Graph>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Graph
build()
A newGraph
instance.org.opendaylight.yangtools.yang.common.Uint32
getAsn()
Return current value associated with the property corresponding toGraph.getAsn()
.Graph.DomainScope
getDomainScope()
Return current value associated with the property corresponding toGraph.getDomainScope()
.Map<EdgeKey,Edge>
getEdge()
Return current value associated with the property corresponding toGraph.getEdge()
.String
getName()
Return current value associated with the property corresponding toGraph.getName()
.Map<PrefixKey,Prefix>
getPrefix()
Return current value associated with the property corresponding toGraph.getPrefix()
.Map<VertexKey,Vertex>
getVertex()
Return current value associated with the property corresponding toGraph.getVertex()
.GraphKey
key()
Return current value associated with the property corresponding toGraph.key()
.GraphBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Graph>> augmentationType)
Remove an augmentation from this builder's product.GraphBuilder
setAsn(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toGraph.getAsn()
to the specified value.GraphBuilder
setDomainScope(Graph.DomainScope value)
Set the property corresponding toGraph.getDomainScope()
to the specified value.GraphBuilder
setEdge(Map<EdgeKey,Edge> values)
Set the property corresponding toGraph.getEdge()
to the specified value.GraphBuilder
setName(String value)
Set the property corresponding toGraph.getName()
to the specified value.GraphBuilder
setPrefix(Map<PrefixKey,Prefix> values)
Set the property corresponding toGraph.getPrefix()
to the specified value.GraphBuilder
setVertex(Map<VertexKey,Vertex> values)
Set the property corresponding toGraph.getVertex()
to the specified value.GraphBuilder
withKey(GraphKey key)
-
-
-
Method Detail
-
key
public GraphKey key()
Return current value associated with the property corresponding toGraph.key()
.- Returns:
- current value
-
getAsn
public org.opendaylight.yangtools.yang.common.Uint32 getAsn()
Return current value associated with the property corresponding toGraph.getAsn()
.- Returns:
- current value
-
getDomainScope
public Graph.DomainScope getDomainScope()
Return current value associated with the property corresponding toGraph.getDomainScope()
.- Returns:
- current value
-
getEdge
public Map<EdgeKey,Edge> getEdge()
Return current value associated with the property corresponding toGraph.getEdge()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toGraph.getName()
.- Returns:
- current value
-
getPrefix
public Map<PrefixKey,Prefix> getPrefix()
Return current value associated with the property corresponding toGraph.getPrefix()
.- Returns:
- current value
-
getVertex
public Map<VertexKey,Vertex> getVertex()
Return current value associated with the property corresponding toGraph.getVertex()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Graph>> 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
-
withKey
public GraphBuilder withKey(GraphKey key)
-
setAsn
public GraphBuilder setAsn(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toGraph.getAsn()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDomainScope
public GraphBuilder setDomainScope(Graph.DomainScope value)
Set the property corresponding toGraph.getDomainScope()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEdge
public GraphBuilder setEdge(Map<EdgeKey,Edge> values)
Set the property corresponding toGraph.getEdge()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setName
public GraphBuilder setName(String value)
Set the property corresponding toGraph.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefix
public GraphBuilder setPrefix(Map<PrefixKey,Prefix> values)
Set the property corresponding toGraph.getPrefix()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setVertex
public GraphBuilder setVertex(Map<VertexKey,Vertex> values)
Set the property corresponding toGraph.getVertex()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public GraphBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Graph> 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 GraphBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Graph>> 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
-
-