Class CodeViewer

java.lang.Object
  extended byCodeViewer

public class CodeViewer
extends java.lang.Object

A class that syntax highlights Java code 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 text, 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
     |__
        multiLineCommentFilter
           |___
                inlineCommentFilter
                   |___
                        stringFilter
                           |__
                               keywordFilter
 


Constructor Summary
CodeViewer()
           
 
Method Summary
 java.lang.String getCommentEnd()
           
 java.lang.String getCommentStart()
           
 java.lang.String getReservedWordEnd()
           
 java.lang.String getReservedWordStart()
           
 java.lang.String getStringEnd()
           
 java.lang.String getStringStart()
           
 void setCommentEnd(java.lang.String commentEnd)
           
 void setCommentStart(java.lang.String commentStart)
           
 void setReservedWordEnd(java.lang.String reservedWordEnd)
           
 void setReservedWordStart(java.lang.String reservedWordStart)
           
 void setStringEnd(java.lang.String stringEnd)
           
 void setStringStart(java.lang.String stringStart)
           
 java.lang.String syntaxHighlight(java.lang.String line)
          Passes off each line to the first filter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodeViewer

public CodeViewer()
Method Detail

setCommentStart

public void setCommentStart(java.lang.String commentStart)

setCommentEnd

public void setCommentEnd(java.lang.String commentEnd)

setStringStart

public void setStringStart(java.lang.String stringStart)

setStringEnd

public void setStringEnd(java.lang.String stringEnd)

setReservedWordStart

public void setReservedWordStart(java.lang.String reservedWordStart)

setReservedWordEnd

public void setReservedWordEnd(java.lang.String reservedWordEnd)

getCommentStart

public java.lang.String getCommentStart()

getCommentEnd

public java.lang.String getCommentEnd()

getStringStart

public java.lang.String getStringStart()

getStringEnd

public java.lang.String getStringEnd()

getReservedWordStart

public java.lang.String getReservedWordStart()

getReservedWordEnd

public java.lang.String getReservedWordEnd()

syntaxHighlight

public java.lang.String syntaxHighlight(java.lang.String line)
Passes off each line to the first filter.

Parameters:
line - The line of Java code to be highlighted.