org.aspectj.org.eclipse.jdt.internal.formatter
Class FormatJavadocNode

java.lang.Object
  org.aspectj.org.eclipse.jdt.internal.formatter.FormatJavadocNode

All Implemented Interfaces:

JavadocTagConstants

Direct Known Subclasses:

FormatJavadocBlock, FormatJavadocReference, FormatJavadocText

public abstract class FormatJavadocNode
extends java.lang.Object
implements JavadocTagConstants

Abstract class for all FormatJavadoc nodes.

The basic information for these nodes are the start and end positions in the source.

Field Summary

protected int	linesBefore
protected int	lineStart
protected int	sourceEnd
protected int	sourceStart

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocTagConstants

ALL_TAGS_LENGTH, BLOCK_IDX, BLOCK_TAGS, BLOCK_TAGS_LENGTH, CLASS_TAGS, COMPILATION_UNIT_TAGS, FIELD_TAGS, HREF_TAG, INLINE_IDX, INLINE_TAGS, INLINE_TAGS_LENGTH, JAVADOC_TAG_TYPE, METHOD_TAGS, NO_TAG_VALUE, ORDERED_TAGS_NUMBER, PACKAGE_TAGS, PARAM_TAG_EXPECTED_ORDER, SEE_TAG_EXPECTED_ORDER, TAG_AUTHOR, TAG_AUTHOR_LENGTH, TAG_AUTHOR_VALUE, TAG_CATEGORY, TAG_CATEGORY_LENGTH, TAG_CATEGORY_VALUE, TAG_CODE, TAG_CODE_LENGTH, TAG_CODE_VALUE, TAG_DEPRECATED, TAG_DEPRECATED_LENGTH, TAG_DEPRECATED_VALUE, TAG_DOC_ROOT, TAG_DOC_ROOT_LENGTH, TAG_DOC_ROOT_VALUE, TAG_EXCEPTION, TAG_EXCEPTION_LENGTH, TAG_EXCEPTION_VALUE, TAG_INHERITDOC, TAG_INHERITDOC_LENGTH, TAG_INHERITDOC_VALUE, TAG_LINK, TAG_LINK_LENGTH, TAG_LINK_VALUE, TAG_LINKPLAIN, TAG_LINKPLAIN_LENGTH, TAG_LINKPLAIN_VALUE, TAG_LITERAL, TAG_LITERAL_LENGTH, TAG_LITERAL_VALUE, TAG_NAMES, TAG_OTHERS_VALUE, TAG_PARAM, TAG_PARAM_LENGTH, TAG_PARAM_VALUE, TAG_RETURN, TAG_RETURN_LENGTH, TAG_RETURN_VALUE, TAG_SEE, TAG_SEE_LENGTH, TAG_SEE_VALUE, TAG_SERIAL, TAG_SERIAL_DATA, TAG_SERIAL_DATA_LENGTH, TAG_SERIAL_DATA_VALUE, TAG_SERIAL_FIELD, TAG_SERIAL_FIELD_LENGTH, TAG_SERIAL_FIELD_VALUE, TAG_SERIAL_LENGTH, TAG_SERIAL_VALUE, TAG_SINCE, TAG_SINCE_LENGTH, TAG_SINCE_VALUE, TAG_THROWS, TAG_THROWS_LENGTH, TAG_THROWS_VALUE, TAG_TYPE_BLOCK, TAG_TYPE_INLINE, TAG_TYPE_NONE, TAG_VALUE, TAG_VALUE_LENGTH, TAG_VALUE_VALUE, TAG_VERSION, TAG_VERSION_LENGTH, TAG_VERSION_VALUE, THROWS_TAG_EXPECTED_ORDER

Constructor Summary

FormatJavadocNode(int start, int end, int line)

Method Summary

int	getLength()
boolean	isImmutable() Returns whether the node is immutable or not.
boolean	isText() Returns whether the node is a text (see FormatJavadocText or not.
java.lang.String	toString()
protected void	toString(java.lang.StringBuffer buffer)
java.lang.String	toStringDebug(char[] source)
void	toStringDebug(java.lang.StringBuffer buffer, char[] source)

Methods inherited from class java.lang.Object

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

Field Detail

sourceStart

protected int sourceStart

sourceEnd

protected int sourceEnd

lineStart

protected int lineStart

linesBefore

protected int linesBefore

Constructor Detail

FormatJavadocNode

public FormatJavadocNode(int start,
                         int end,
                         int line)

Method Detail

getLength

public int getLength()

isText

public boolean isText()

Returns whether the node is a text (see FormatJavadocText or not. In case not, that means that the node is an block (see FormatJavadocBlock).

Returns:

true if the node is a text false otherwise.

isImmutable

public boolean isImmutable()

Returns whether the node is immutable or not. If true, then the formatter will leave it contents unchanged.

Returns:

true if the node is immutable, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

protected void toString(java.lang.StringBuffer buffer)

toStringDebug

public java.lang.String toStringDebug(char[] source)

toStringDebug

public void toStringDebug(java.lang.StringBuffer buffer,
                          char[] source)