Class JavadocContents

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.JavadocContents

All Implemented Interfaces:

IJavadocContents

Direct Known Subclasses:

JavadocContents17

public class JavadocContents
extends Object
implements IJavadocContents

Javadoc tool format compatible with Java 11 and earlier versions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	JavadocContents.Range

Field Summary

Fields

Modifier and Type	Field	Description
protected int	childrenStart
protected final char[]	content
protected int[]	fieldAnchorIndexes
protected int	fieldAnchorIndexesCount
protected Map<IField,JavadocContents.Range>	fieldDocRanges
protected int	fieldLastAnchorFoundIndex
protected boolean	hasComputedChildrenSections
protected int	indexOfAllMethodsBottom
protected int	indexOfAllMethodsTop
protected int	indexOfConstructorDetails
protected int	indexOfEndOfClassData
protected int	indexOfFieldDetails
protected int	indexOfFieldsBottom
protected int	indexOfMethodDetails
protected int[]	methodAnchorIndexes
protected int	methodAnchorIndexesCount
protected Map<BinaryMethod,JavadocContents.Range>	methodDocRanges
protected int	methodLastAnchorFoundIndex
protected int[]	tempAnchorIndexes
protected int	tempAnchorIndexesCount
protected int	tempLastAnchorFoundIndex
protected BinaryType	type
protected JavadocContents.Range	typeDocRange
protected static final JavadocContents.Range	UNKNOWN_FORMAT
protected int[]	unknownFormatAnchorIndexes
protected int	unknownFormatAnchorIndexesCount
protected int	unknownFormatLastAnchorFoundIndex

Method Summary

Modifier and Type	Method	Description
protected JavadocContents.Range	computeChildRange(char[] anchor, int indexOfSectionBottom)
protected JavadocContents.Range	computeChildRange(int anchorEndStart, char[] anchor, int indexOfBottom)
protected void	computeChildrenSections()
protected JavadocContents.Range	computeFieldRange(IField field)
protected String	computeMethodAnchorPrefixEnd(BinaryMethod method)
protected JavadocContents.Range	computeMethodRange(BinaryMethod method)
protected void	computeTypeRange()
protected String	createSignatureAnchor(BinaryMethod method, String methodName, IBinaryMethod info)
protected int[]	getAnchorIndex(int fromIndex)
String	getFieldDoc(IField child)	Returns the part of the javadoc that describes a field of the type
String	getMethodDoc(IMethod child)	Returns the part of the javadoc that describe a method of the type
protected String	getMethodName(BinaryMethod method)
String	getModuleDoc()	Returns the part of the javadoc that describes the module
String	getPackageDoc()	Returns the part of the javadoc that describes the package
String	getTypeDoc()	Returns the part of the javadoc that describes the type

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_FORMAT

protected static final JavadocContents.Range UNKNOWN_FORMAT

type

protected BinaryType type

content

protected final char[] content

childrenStart

protected int childrenStart

hasComputedChildrenSections

protected boolean hasComputedChildrenSections

indexOfFieldDetails

protected int indexOfFieldDetails

indexOfConstructorDetails

protected int indexOfConstructorDetails

indexOfMethodDetails

protected int indexOfMethodDetails

indexOfEndOfClassData

protected int indexOfEndOfClassData

indexOfFieldsBottom

protected int indexOfFieldsBottom

indexOfAllMethodsTop

protected int indexOfAllMethodsTop

indexOfAllMethodsBottom

protected int indexOfAllMethodsBottom

typeDocRange

protected JavadocContents.Range typeDocRange

fieldDocRanges

protected Map<IField,JavadocContents.Range> fieldDocRanges

methodDocRanges

protected Map<BinaryMethod,JavadocContents.Range> methodDocRanges

fieldAnchorIndexes

protected int[] fieldAnchorIndexes

fieldAnchorIndexesCount

protected int fieldAnchorIndexesCount

fieldLastAnchorFoundIndex

protected int fieldLastAnchorFoundIndex

methodAnchorIndexes

protected int[] methodAnchorIndexes

methodAnchorIndexesCount

protected int methodAnchorIndexesCount

methodLastAnchorFoundIndex

protected int methodLastAnchorFoundIndex

unknownFormatAnchorIndexes

protected int[] unknownFormatAnchorIndexes

unknownFormatAnchorIndexesCount

protected int unknownFormatAnchorIndexesCount

unknownFormatLastAnchorFoundIndex

protected int unknownFormatLastAnchorFoundIndex

tempAnchorIndexes

protected int[] tempAnchorIndexes

tempAnchorIndexesCount

protected int tempAnchorIndexesCount

tempLastAnchorFoundIndex

protected int tempLastAnchorFoundIndex

Method Details

getTypeDoc

public String getTypeDoc()
                  throws JavaModelException

Description copied from interface: IJavadocContents

Returns the part of the javadoc that describes the type

Specified by:

getTypeDoc in interface IJavadocContents

Throws:

JavaModelException

getPackageDoc

public String getPackageDoc()
                     throws JavaModelException

Description copied from interface: IJavadocContents

Returns the part of the javadoc that describes the package

Specified by:

getPackageDoc in interface IJavadocContents

Throws:

JavaModelException

getModuleDoc

public String getModuleDoc()
                    throws JavaModelException

Description copied from interface: IJavadocContents

Returns the part of the javadoc that describes the module

Specified by:

getModuleDoc in interface IJavadocContents

Throws:

JavaModelException

getFieldDoc

public String getFieldDoc(IField child)
                   throws JavaModelException

Description copied from interface: IJavadocContents

Returns the part of the javadoc that describes a field of the type

Specified by:

getFieldDoc in interface IJavadocContents

Throws:

JavaModelException

getMethodDoc

public String getMethodDoc(IMethod child)
                    throws JavaModelException

Description copied from interface: IJavadocContents

Returns the part of the javadoc that describe a method of the type

Specified by:

getMethodDoc in interface IJavadocContents

Throws:

JavaModelException

computeChildRange

protected JavadocContents.Range computeChildRange(char[] anchor,
 int indexOfSectionBottom)
                                           throws JavaModelException

Throws:

JavaModelException

getAnchorIndex

protected int[] getAnchorIndex(int fromIndex)

computeChildRange

protected JavadocContents.Range computeChildRange(int anchorEndStart,
 char[] anchor,
 int indexOfBottom)

computeChildrenSections

protected void computeChildrenSections()

computeFieldRange

protected JavadocContents.Range computeFieldRange(IField field)
                                           throws JavaModelException

Throws:

JavaModelException

computeMethodRange

protected JavadocContents.Range computeMethodRange(BinaryMethod method)
                                            throws JavaModelException

Throws:

JavaModelException

computeMethodAnchorPrefixEnd

protected String computeMethodAnchorPrefixEnd(BinaryMethod method)
                                       throws JavaModelException

Throws:

JavaModelException

createSignatureAnchor

protected String createSignatureAnchor(BinaryMethod method,
 String methodName,
 IBinaryMethod info)
                                throws JavaModelException

Throws:

JavaModelException

getMethodName

protected String getMethodName(BinaryMethod method)
                        throws JavaModelException

Throws:

JavaModelException

computeTypeRange

protected void computeTypeRange()
                         throws JavaModelException

Throws:

JavaModelException