Interface SourceCodeAnalysis.Documentation
- Enclosing class:
SourceCodeAnalysis
public static interface SourceCodeAnalysis.Documentation
A documentation for a candidate for continuation of the given user's input.
- Since:
- 9
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
default int |
activeParameterIndex() |
If this Documentation is created for a method invocation, return the current parameter index. |
String |
javadoc() |
The javadoc of the given element. |
String |
signature() |
The signature of the given element. |
Method Details
signature
String signature()
The signature of the given element.
- Returns:
- the signature
javadoc
String javadoc()
The javadoc of the given element.
- Returns:
- the javadoc, or null if not found or not requested
activeParameterIndex
default int activeParameterIndex()
If this
Documentation is created for a method invocation, return the current parameter index.- Implementation Note:
- the default implementation returns
-1 - Returns:
- the active parameter index, or
-1if not available - Since:
- 26
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
