public class DependencyGraphParser extends Object
line ::= (indent? ("(null)" | node | reference))? comment? comment ::= "#" rest-of-line indent ::= "| "* ("+" | "\\") "- " reference ::= "^" id node ::= coords (range)? space (scope("<" premanagedScope)?)? space "optional"? space ("relocations=" coords ("," coords)*)? ("(" id ")")? coords ::= groupId ":" artifactId (":" extension (":" classifier)?)? ":" versionThe special token
(null)
may be used to indicate an "empty" root node with no dependency.
If indent
is empty, the line defines the root node. Only one root node may be defined. The level is
calculated by the distance from the beginning of the line. One level is three characters of indentation.
The ^id
syntax allows to reuse a previously built node to share common sub graphs among different parent
nodes.
gid:aid:ver +- gid:aid2:ver scope | \- gid:aid3:ver (id1) # assign id for reference below +- gid:aid4:ext:ver scope \- ^id1 # reuse previous node
By using parseMultiResource(String)
, definitions divided by a line beginning with "---" can be read from the
same resource. The rest of the line is ignored.
You may define substitutions (see setSubstitutions(String...)
,
DependencyGraphParser(String, Collection)
). Every '%s' in the definition will be substituted by the next
String in the defined substitutions.
parser.setSubstitutions( "foo", "bar" ); String def = "gid:%s:ext:ver\n" + "+- gid:%s:ext:ver";The first node will have "foo" as its artifact id, the second node (child to the first) will have "bar" as its artifact id.
Constructor and Description |
---|
DependencyGraphParser()
Create a parser with an empty prefix.
|
DependencyGraphParser(String prefix)
Create a parser with the given prefix.
|
DependencyGraphParser(String prefix,
Collection<String> substitutions)
Create a parser with the given prefix and the given substitution strings.
|
Modifier and Type | Method and Description |
---|---|
String |
dump(DependencyNode root) |
Collection<String> |
getSubstitutions() |
DependencyNode |
parse(URL resource)
Parse the graph definition read from the given URL.
|
DependencyNode |
parseLiteral(String dependencyGraph)
Parse the given graph definition.
|
List<DependencyNode> |
parseMultiResource(String resource)
Parse multiple graphs in one resource, divided by "---".
|
DependencyNode |
parseResource(String resource)
Parse the graph definition read from the given classpath resource.
|
void |
setSubstitutions(Collection<String> substitutions) |
void |
setSubstitutions(String... substitutions) |
public DependencyGraphParser(String prefix, Collection<String> substitutions)
parseResource(String)
public DependencyGraphParser(String prefix)
parseResource(String)
public DependencyGraphParser()
public DependencyNode parseLiteral(String dependencyGraph) throws IOException
IOException
public DependencyNode parseResource(String resource) throws IOException
IOException
public List<DependencyNode> parseMultiResource(String resource) throws IOException
IOException
public DependencyNode parse(URL resource) throws IOException
IOException
public String dump(DependencyNode root)
public Collection<String> getSubstitutions()
public void setSubstitutions(Collection<String> substitutions)
public void setSubstitutions(String... substitutions)
Copyright © 2010–2019 The Apache Software Foundation. All rights reserved.