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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Graph>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Graph,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class GraphBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Graph>
Class that buildsGraphBuilder
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:
GraphBuilder createTarget(int fooXyzzy, int barBaz) { return new GraphBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GraphBuilder, 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 oportunities, 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:
GraphBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GraphBuilder()
GraphBuilder(Graph base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
Graph
build()
org.opendaylight.yangtools.yang.common.Uint32
getAsn()
Graph.DomainScope
getDomainScope()
Map<EdgeKey,Edge>
getEdge()
String
getName()
Map<PrefixKey,Prefix>
getPrefix()
Map<VertexKey,Vertex>
getVertex()
GraphKey
key()
GraphBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Graph>> augmentationType)
Remove an augmentation from this builder's product.GraphBuilder
setAsn(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAsn(Uint32)
instead.GraphBuilder
setAsn(org.opendaylight.yangtools.yang.common.Uint32 value)
GraphBuilder
setDomainScope(Graph.DomainScope value)
GraphBuilder
setEdge(List<Edge> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEdge(Map)
instead.GraphBuilder
setEdge(Map<EdgeKey,Edge> values)
GraphBuilder
setName(String value)
GraphBuilder
setPrefix(List<Prefix> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPrefix(Map)
instead.GraphBuilder
setPrefix(Map<PrefixKey,Prefix> values)
GraphBuilder
setVertex(List<Vertex> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVertex(Map)
instead.GraphBuilder
setVertex(Map<VertexKey,Vertex> values)
GraphBuilder
withKey(GraphKey key)
-
-
-
Constructor Detail
-
GraphBuilder
public GraphBuilder()
-
GraphBuilder
public GraphBuilder(Graph base)
-
-
Method Detail
-
key
public GraphKey key()
-
getAsn
public org.opendaylight.yangtools.yang.common.Uint32 getAsn()
-
getDomainScope
public Graph.DomainScope getDomainScope()
-
getName
public String getName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Graph>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public GraphBuilder withKey(GraphKey key)
-
setAsn
public GraphBuilder setAsn(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setAsn
@Deprecated(forRemoval=true) public GraphBuilder setAsn(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAsn(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDomainScope
public GraphBuilder setDomainScope(Graph.DomainScope value)
-
setEdge
public GraphBuilder setEdge(Map<EdgeKey,Edge> values)
-
setEdge
@Deprecated(forRemoval=true) public GraphBuilder setEdge(List<Edge> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEdge(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setName
public GraphBuilder setName(String value)
-
setPrefix
public GraphBuilder setPrefix(Map<PrefixKey,Prefix> values)
-
setPrefix
@Deprecated(forRemoval=true) public GraphBuilder setPrefix(List<Prefix> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPrefix(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setVertex
public GraphBuilder setVertex(Map<VertexKey,Vertex> values)
-
setVertex
@Deprecated(forRemoval=true) public GraphBuilder setVertex(List<Vertex> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVertex(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
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
-
build
public Graph build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Graph>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Graph,IllegalArgumentException>
-
-