org.apache.maven.jxr
public class JavaCodeTransform extends Object implements Serializable
htmlFilter |__ multiLineCommentFilter -> uriFilter |___ inlineCommentFilter |___ stringFilter |___ keywordFilter |___ uriFilter |___ jxrFilter |___ importFilter
Field Summary | |
---|---|
static String | COMMENT_END
end comment delimeter |
static String | COMMENT_START
start comment delimeter |
static String | JAVADOC_COMMENT_END
end javadoc comment delimeter |
static String | JAVADOC_COMMENT_START
start javadoc comment delimeter |
static boolean | LINE_NUMBERS
show line numbers |
static String | RESERVED_WORD_END
end reserved word delimeter |
static String | RESERVED_WORD_START
start reserved word delimeter |
static String | STRING_END
end String delimeter |
static String | STRING_START
start String delimeter |
static String | STYLESHEET_FILENAME
stylesheet file name |
static char[] | VALID_URI_CHARS
Specify the only characters that are allowed in a URI besides alpha and
numeric characters. |
static String[] | VALID_URI_SCHEMES
Description of the Field |
Constructor Summary | |
---|---|
JavaCodeTransform(PackageManager packageManager)
Constructor for the JavaCodeTransform object
|
Method Summary | |
---|---|
String | getCurrentFilename()
Get the current filename
|
String | getDestfile()
The current dest file being written
|
String | getFooter()
Gets the footer attribute of the JavaCodeTransform object
|
String | getHeader()
Gets the header attribute of the JavaCodeTransform object
|
String | getPackageRoot()
From the current file, determine the package root based on the current
path.
|
String | getRevision()
The current revision of the CVS module
|
String | getSourceDirectory()
The current source directory being read from.
|
String | getSourcefile()
The current source file being read
|
void | setCurrentFilename(String filename)
Set the current filename
|
String | syntaxHighlight(String line)
Now different method of seeing if at end of input stream, closes inputs
stream at end.
|
void | transform(Reader sourceReader, Writer destWriter, Locale locale, String inputEncoding, String outputEncoding, String javadocLinkDir, String revision, boolean showHeader, boolean showFooter)
This is the public method for doing all transforms of code.
|
void | transform(String sourcefile, String destfile, Locale locale, String inputEncoding, String outputEncoding, String javadocLinkDir, String revision)
This is the public method for doing all transforms of code.
|
String | uriFilter(String line)
Given a line of text, search for URIs and make href's out of them
|
String | xrLine(String line, String packageName, ClassType classType)
Cross Reference the given line with JXR returning the new content.
|
String | xrLine(String line, String packageName)
Highlight the package in this line.
|
Parameters: packageManager PackageManager for this project
Returns: String
Returns: destination file name
Returns: String
Returns: String
Returns: String
Returns: String
Returns: source directory
Returns: source file name
Parameters: filename String
Parameters: line String
Returns: filtered line of code
Parameters: sourceReader Reader destWriter Writer locale String inputEncoding String outputEncoding String javadocLinkDir String revision String showHeader boolean showFooter boolean
Throws: IOException
Parameters: sourcefile String destfile String locale String inputEncoding String outputEncoding String javadocLinkDir String revision String
Throws: IOException
Parameters: line String
Returns: String
Parameters: line String packageName String classType ClassType
Returns: String
Parameters: line input line packageName package name
Returns: input line with linked package