org.apache.maven.jxr

Class JavaCodeTransform

java.lang.Object

org.apache.maven.jxr.JavaCodeTransform

All Implemented Interfaces:

Serializable

public class JavaCodeTransform
extends Object
implements Serializable

Syntax highlights java by turning it into HTML. A codeviewer object is created and then keeps state as lines are passed in. Each line passed in as java test, is returned as syntax highlighted HTML text. Users of the class can set how the java code will be highlighted with setter methods. Only valid java lines should be passed in since the object maintains state and may not handle illegal code gracefully. The actual system is implemented as a series of filters that deal with specific portions of the java code. The filters are as follows:

  htmlFilter
    |__
      ongoingMultiLineCommentFilter -> uriFilter
        |__
          inlineCommentFilter
            |__
              beginMultiLineCommentFilter -> ongoingMultiLineCommentFilter
                |__
                  stringFilter
                    |__
                      keywordFilter
                        |__
                          uriFilter
                            |__
                              jxrFilter
                                |__
                                  importFilter
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JavaCodeTransform(PackageManager packageManager, FileManager fileManager)

Method Summary

Modifier and Type	Method and Description
String	getRevision() The current revision of the module.
void	transform(Path sourcefile, Path destfile, Locale locale, String inputEncoding, String outputEncoding, Path javadocLinkDir, String revision, String bottom) This is the public method for doing all transforms of code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaCodeTransform

public JavaCodeTransform(PackageManager packageManager,
                         FileManager fileManager)

Method Detail

transform

public final void transform(Path sourcefile,
                            Path destfile,
                            Locale locale,
                            String inputEncoding,
                            String outputEncoding,
                            Path javadocLinkDir,
                            String revision,
                            String bottom)
                     throws IOException

This is the public method for doing all transforms of code.

Parameters:

sourcefile - source file

destfile - destination file

locale - locale

inputEncoding - input encoding

outputEncoding - output encoding

javadocLinkDir - relative path to javadocs

revision - revision of the module

bottom - bottom text

Throws:

IOException - in I/O failures in reading/writing files

getRevision

public final String getRevision()

The current revision of the module.

Returns:

revision