org.sourceflow.visualbasic
Class VisualBasicComment

java.lang.Object
  org.sourceflow.CodeElement
      org.sourceflow.visualbasic.VisualBasicComment

All Implemented Interfaces:

java.lang.Comparable

public class VisualBasicComment

extends CodeElement

A class generating a Visual Basic comment.

Field Summary

static int	DOCUMENTATION The documentation comment type.
static int	SINGLELINE The single line comment type.

Constructor Summary

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

VisualBasicComment(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 comment to the specified stream.

Methods inherited from class org.sourceflow.CodeElement

compareTo, printSeparator

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 documentation comment type. Note that this type may be used even if the comment spans several lines, as the ''' characters will be duplicated for each line.

See Also:

Constant Field Values

SINGLELINE

public static final int SINGLELINE

The single line comment type. Note that this type may be used even if the comment spans several lines, as the ' character will be duplicated for each line.

See Also:

Constant Field Values

Constructor Detail

VisualBasicComment

public VisualBasicComment(java.lang.String comment)

Creates a new documentation comment with no indentation.

Parameters:

comment - the comment text

VisualBasicComment

public VisualBasicComment(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, 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 comment to the specified stream.

Specified by:

print in class CodeElement

Parameters:

out - the output stream

style - the code style to use

indent - the indentation level