LUCENE-4199: update javadocs and printout for no longer method-only checks

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene4199@1358653 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Uwe Schindler 2012-07-07 22:03:22 +00:00
parent c728aca01b
commit 0ca4f678ed
1 changed files with 7 additions and 7 deletions

View File

@ -57,8 +57,8 @@ import java.util.Locale;
import java.util.Map; import java.util.Map;
/** /**
* Task to check if a set of class files contains calls to forbidden methods * Task to check if a set of class files contains calls to forbidden APIs
* from a given classpath and list of methods (either inline or as pointer to files). * from a given classpath and list of API signatures (either inline or as pointer to files).
*/ */
public class ForbiddenApisCheckTask extends Task { public class ForbiddenApisCheckTask extends Task {
@ -187,7 +187,7 @@ public class ForbiddenApisCheckTask extends Task {
} }
} }
/** Reads a list of method signatures. Closes the Reader when done (on Exception, too)! */ /** Reads a list of API signatures. Closes the Reader when done (on Exception, too)! */
private void parseApiFile(ClassLoader loader, Reader reader) throws IOException { private void parseApiFile(ClassLoader loader, Reader reader) throws IOException {
final BufferedReader r = new BufferedReader(reader); final BufferedReader r = new BufferedReader(reader);
try { try {
@ -252,12 +252,12 @@ public class ForbiddenApisCheckTask extends Task {
} }
log(String.format(Locale.ROOT, log(String.format(Locale.ROOT,
"Scanned %d class file(s) for forbidden method invocations (in %.2fs), %d error(s).", "Scanned %d class file(s) for forbidden API invocations (in %.2fs), %d error(s).",
checked, (System.currentTimeMillis() - start) / 1000.0, errors), checked, (System.currentTimeMillis() - start) / 1000.0, errors),
errors > 0 ? Project.MSG_ERR : Project.MSG_INFO); errors > 0 ? Project.MSG_ERR : Project.MSG_INFO);
if (errors > 0) { if (errors > 0) {
throw new BuildException("Check for forbidden method calls failed, see log."); throw new BuildException("Check for forbidden API calls failed, see log.");
} }
} finally { } finally {
if (loader != null) loader.cleanup(); if (loader != null) loader.cleanup();
@ -269,12 +269,12 @@ public class ForbiddenApisCheckTask extends Task {
classFiles.add(rc); classFiles.add(rc);
} }
/** A file with method signatures apiFile= attribute */ /** A file with API signatures apiFile= attribute */
public void setApiFile(File file) { public void setApiFile(File file) {
apiSignatures.add(new FileResource(getProject(), file)); apiSignatures.add(new FileResource(getProject(), file));
} }
/** Set of files with method signatures as <apiFileSet/> nested element */ /** Set of files with API signatures as <apiFileSet/> nested element */
public FileSet createApiFileSet() { public FileSet createApiFileSet() {
final FileSet fs = new FileSet(); final FileSet fs = new FileSet();
fs.setProject(getProject()); fs.setProject(getProject());