/**
* Returns the reason for why the Javadoc of the Java element could not be retrieved.
*
* @param element whose Javadoc could not be retrieved
* @param root the root of the Java element
* @return the String message for why the Javadoc could not be retrieved for the Java element or
* <code>null</code> if the Java element is from a source container
* @since 3.9
*/
public static String getExplanationForMissingJavadoc(
IJavaElement element, IPackageFragmentRoot root) {
String message = null;
try {
boolean isBinary = (root.exists() && root.getKind() == IPackageFragmentRoot.K_BINARY);
if (isBinary) {
boolean hasAttachedJavadoc = JavaDocLocations.getJavadocBaseLocation(element) != null;
boolean hasAttachedSource = root.getSourceAttachmentPath() != null;
IOpenable openable = element.getOpenable();
boolean hasSource = openable.getBuffer() != null;
// Provide hint why there's no Java doc
if (!hasAttachedSource && !hasAttachedJavadoc)
message = CorextMessages.JavaDocLocations_noAttachments;
else if (!hasAttachedJavadoc && !hasSource)
message = CorextMessages.JavaDocLocations_noAttachedJavadoc;
else if (!hasAttachedSource) message = CorextMessages.JavaDocLocations_noAttachedSource;
else if (!hasSource) message = CorextMessages.JavaDocLocations_noInformation;
}
} catch (JavaModelException e) {
message = CorextMessages.JavaDocLocations_error_gettingJavadoc;
JavaPlugin.log(e);
}
return message;
}
