org.aspectj.org.eclipse.jdt.internal.formatter.comment
Class JavaDocLine

java.lang.Object
  org.aspectj.org.eclipse.jdt.internal.formatter.comment.CommentLine
      org.aspectj.org.eclipse.jdt.internal.formatter.comment.MultiCommentLine
          org.aspectj.org.eclipse.jdt.internal.formatter.comment.JavaDocLine

All Implemented Interfaces:

IBorderAttributes, ICommentAttributes, IHtmlTagDelimiters, IJavaDocTagConstants

public class JavaDocLine
extends MultiCommentLine

Javadoc comment line in a comment region.

Since:

3.0

Field Summary

static java.lang.String

JAVADOC_START_PREFIX Line prefix of javadoc start lines

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.formatter.comment.MultiCommentLine

MULTI_COMMENT_CONTENT_PREFIX, MULTI_COMMENT_END_PREFIX, MULTI_COMMENT_START_PREFIX

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.formatter.comment.CommentLine

NON_FORMAT_START_PREFIX

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.formatter.comment.ICommentAttributes

COMMENT_BLANKLINE, COMMENT_BREAK, COMMENT_CLOSE, COMMENT_CODE, COMMENT_FIRST_TOKEN, COMMENT_HTML, COMMENT_IMMUTABLE, COMMENT_NEWLINE, COMMENT_OPEN, COMMENT_PARAGRAPH, COMMENT_PARAMETER, COMMENT_ROOT, COMMENT_SEPARATOR, COMMENT_STARTS_WITH_RANGE_DELIMITER

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.formatter.comment.IHtmlTagDelimiters

HTML_CLOSE_PREFIX, HTML_TAG_POSTFIX, HTML_TAG_PREFIX

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.formatter.comment.IJavaDocTagConstants

COMMENT_ROOT_TAGS, COMMENT_TAG_PREFIX, JAVADOC_BREAK_TAGS, JAVADOC_CODE_TAGS, JAVADOC_IMMUTABLE_TAGS, JAVADOC_NEWLINE_TAGS, JAVADOC_PARAM_TAGS, JAVADOC_SEPARATOR_TAGS, JAVADOC_SINGLE_BREAK_TAG, JAVADOC_TAG_PREFIX, LINK_TAG_POSTFIX, LINK_TAG_PREFIX, LINK_TAG_PREFIX_STRING

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.formatter.comment.IBorderAttributes

BORDER_LOWER, BORDER_UPPER

Constructor Summary

protected

JavaDocLine(CommentRegion region) Creates a new javadoc line.

Method Summary

protected void	formatUpperBorder(CommentRange range, java.lang.String indentation, int length) Formats this comment line as start line having an upper border consisting of content line prefixes.
protected java.lang.String	getStartingPrefix() Returns the line prefix of start lines.

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.formatter.comment.MultiCommentLine

adapt, append, getContentPrefix, getEndingPrefix, getIndentationReference, scanLine, tokenizeLine, trimLine

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.formatter.comment.CommentLine

formatLine, formatLowerBorder, getFirst, getLast, getParent, getSize, hasAttribute, setAttribute, toString

Methods inherited from class java.lang.Object

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

Field Detail

JAVADOC_START_PREFIX

public static final java.lang.String JAVADOC_START_PREFIX

Line prefix of javadoc start lines

See Also:

Constant Field Values

Constructor Detail

JavaDocLine

protected JavaDocLine(CommentRegion region)

Creates a new javadoc line.

Parameters:

region - comment region to create the line for

Method Detail

formatUpperBorder

protected void formatUpperBorder(CommentRange range,
                                 java.lang.String indentation,
                                 int length)

Description copied from class: CommentLine

Formats this comment line as start line having an upper border consisting of content line prefixes.

Overrides:

formatUpperBorder in class CommentLine

Parameters:

range - the first comment range in the comment region

indentation - the indentation of the comment region

length - the maximal length of text in this comment region measured in average character widths

getStartingPrefix

protected java.lang.String getStartingPrefix()

Description copied from class: CommentLine

Returns the line prefix of start lines.

Overrides:

getStartingPrefix in class MultiCommentLine

Returns:

line prefix of start lines