Package org.java.plugin.tools.docgen
Class DocGenerator.Tool
- java.lang.Object
-
- org.java.plugin.tools.docgen.DocGenerator.Tool
-
- Enclosing class:
- DocGenerator
public static final class DocGenerator.Tool extends java.lang.Object
Utility class to be used from JXP templates.- Version:
- $Id$
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Tool(java.lang.String aRelativePath)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getLink(Documentation.Reference<?> ref)
boolean
isAbsoluteUrl(java.lang.String url)
java.lang.String
processDocText(java.lang.String text)
Substitutes all ${relativePath} variables with their values.
-
-
-
Method Detail
-
getLink
public java.lang.String getLink(Documentation.Reference<?> ref)
- Parameters:
ref
- documentation reference element- Returns:
- link to be used in "href" attribute
-
isAbsoluteUrl
public boolean isAbsoluteUrl(java.lang.String url)
- Parameters:
url
- an URL to check- Returns:
true
if given link is an absolute URL
-
processDocText
public java.lang.String processDocText(java.lang.String text)
Substitutes all ${relativePath} variables with their values.- Parameters:
text
- text to be processed- Returns:
- processed documentation text
-
-