net.percederberg.grammatica.code.java
Class JavaComment

java.lang.Object
  |
  +--net.percederberg.grammatica.code.CodeElement
        |
        +--net.percederberg.grammatica.code.java.JavaComment
All Implemented Interfaces:
java.lang.Comparable

public class JavaComment
extends CodeElement

A class generating a Java comment.

Version:
1.0
Author:
Per Cederberg,

Field Summary
static int BLOCK
          The block comment type.
static int DOCUMENTATION
          The JavaDoc documentation comment type.
static int SINGLELINE
          The single line comment type.
 
Constructor Summary
JavaComment(int type, java.lang.String comment)
          Creates a new comment of the specified type.
JavaComment(java.lang.String comment)
          Creates a new documentation comment with no indentation.
 
Method Summary
 int category()
          Returns a numeric category number for the code element.
 void print(java.io.PrintWriter out, CodeStyle style, int indent)
          Prints the code element to the specified output stream.
 
Methods inherited from class net.percederberg.grammatica.code.CodeElement
compareTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOCUMENTATION

public static final int DOCUMENTATION
The JavaDoc documentation comment type.

See Also:
Constant Field Values

BLOCK

public static final int BLOCK
The block comment type.

See Also:
Constant Field Values

SINGLELINE

public static final int SINGLELINE
The single line comment type. Note that this may be used even if the comment spans several lines, as the // characters will be duplicated for each line.

See Also:
Constant Field Values
Constructor Detail

JavaComment

public JavaComment(java.lang.String comment)
Creates a new documentation comment with no indentation.

Parameters:
comment - the comment text

JavaComment

public JavaComment(int type,
                   java.lang.String comment)
Creates a new comment of the specified type.

Parameters:
type - the comment type
comment - the comment text
See Also:
DOCUMENTATION, BLOCK, SINGLELINE
Method Detail

category

public int category()
Returns a numeric category number for the code element. A lower category number implies that the code element should be placed before code elements with a higher category number within a declaration.

Specified by:
category in class CodeElement
Returns:
the category number

print

public void print(java.io.PrintWriter out,
                  CodeStyle style,
                  int indent)
Prints the code element to the specified output stream.

Specified by:
print in class CodeElement
Parameters:
out - the output stream
style - the code style to use
indent - the indentation level