net.sourceforge.jenesis4java

Interface Comment

All Superinterfaces:

Codeable

All Known Subinterfaces:

DocumentationComment

public interface Comment
extends Codeable

The Comment superinterface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_WITHOUT_INTERMEDIARY_STARS Deprecated. This will be removed in the future. Use MULTI_LINE instead.
static int	D Deprecated. prefer more descriptive DOCUMENTATION
static int	DOCUMENTATION Type constant for a documentation comment.
static int	M Deprecated. prefer more descriptive MULTI_LINE
static int	Mbe Deprecated. prefer more descriptive BLOCK_WITHOUT_INTERMEDIARY_STARS
static int	MULTI_LINE Type constant for a multiple line comment.
static int	S Deprecated. prefer more descriptive SINGLE_LINE
static int	SINGLE_LINE Type constant for a single line comment.
static int	TRAILING Type constant for a trailing comment.

Method Summary

Methods

Modifier and Type	Method and Description
String	getText() Gets the text for this comment.
int	getType() Returns the type of this comment.
Comment	setText(String text) Sets the text for this comment.
int	type() Deprecated. Name does not follow naming convention. Use getType() instead.

Methods inherited from interface net.sourceforge.jenesis4java.Codeable

applyStyle, cast, getComment, isActive, isBlockWithAbruptCompletion, setComment, toCode, visit, vm

Field Detail

SINGLE_LINE

static final int SINGLE_LINE

Type constant for a single line comment.

See Also:

Constant Field Values

S

@Deprecated
static final int S

Deprecated. prefer more descriptive SINGLE_LINE

Type constant for a single line comment.

See Also:

Constant Field Values

MULTI_LINE

static final int MULTI_LINE

Type constant for a multiple line comment.

See Also:

Constant Field Values

M

@Deprecated
static final int M

Deprecated. prefer more descriptive MULTI_LINE

Type constant for a multiple line comment.

See Also:

Constant Field Values

BLOCK_WITHOUT_INTERMEDIARY_STARS

@Deprecated
static final int BLOCK_WITHOUT_INTERMEDIARY_STARS

Deprecated. This will be removed in the future. Use MULTI_LINE instead.

Type constant for a multiple line comment, but only at the beginning and at the end.

See Also:

Constant Field Values

Mbe

@Deprecated
static final int Mbe

Deprecated. prefer more descriptive BLOCK_WITHOUT_INTERMEDIARY_STARS

Type constant for a multiple line comment, but only at the beginning and at the end.

See Also:

Constant Field Values

DOCUMENTATION

static final int DOCUMENTATION

Type constant for a documentation comment.

See Also:

Constant Field Values

D

@Deprecated
static final int D

Deprecated. prefer more descriptive DOCUMENTATION

Type constant for a documentation comment.

See Also:

Constant Field Values

TRAILING

static final int TRAILING

Type constant for a trailing comment. A trailing comment is on the same line as the element.

If putting the comment in a trailing position fails, it will be treated like a SINGLE_LINE comment.

Note: Feature is still incomplete and is tested on statements only.

See Also:

Constant Field Values

Method Detail

getText

String getText()

Gets the text for this comment.

setText

Comment setText(String text)

Sets the text for this comment.

type

@Deprecated
int type()

Deprecated. Name does not follow naming convention. Use getType() instead.

Returns the type of this comment.

getType

int getType()

Returns the type of this comment.