Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor jdoc fixes for PerfTask 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1235714 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Shai Erera 2012-01-25 10:42:00 +00:00
parent d0e4e731d9
commit 640741783d
1 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PerfTask.java
View File

@ -199,9 +199,6 @@ public abstract class PerfTask implements Cloneable {
return new String(c); return new String(c);
} }
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override @Override
public String toString() { public String toString() {
String padd = getPadding(); String padd = getPadding();
@ -248,22 +245,23 @@ public abstract class PerfTask implements Cloneable {
} }
/** /**
* Task setup work that should not be measured for that specific task. * Task setup work that should not be measured for that specific task. By
* By default it does nothing, but tasks can implement this, moving work from * default it does nothing, but tasks can implement this, moving work from
* doLogic() to this method. Only the work done in doLogicis measured for this task. * {@link #doLogic()} to this method. Only the work done in {@link #doLogic()}
* Notice that higher level (sequence) tasks containing this task would then * is measured for this task. Notice that higher level (sequence) tasks
* measure larger time than the sum of their contained tasks. * containing this task would then measure larger time than the sum of their
* @throws Exception * contained tasks.
*/ */
public void setup () throws Exception { public void setup () throws Exception {
} }
/** /**
* Task tearDown work that should not be measured for that specific task. * Task tearDown work that should not be measured for that specific task. By
* By default it does nothing, but tasks can implement this, moving work from * default it does nothing, but tasks can implement this, moving work from
* doLogic() to this method. Only the work done in doLogicis measured for this task. * {@link #doLogic()} to this method. Only the work done in {@link #doLogic()}
* Notice that higher level (sequence) tasks containing this task would then * is measured for this task. Notice that higher level (sequence) tasks
* measure larger time than the sum of their contained tasks. * containing this task would then measure larger time than the sum of their
* contained tasks.
*/ */
public void tearDown() throws Exception { public void tearDown() throws Exception {
if (++logStepCount % logStep == 0) { if (++logStepCount % logStep == 0) {
@ -274,16 +272,20 @@ public abstract class PerfTask implements Cloneable {
} }
/** /**
* Sub classes that supports parameters must override this method to return true. * Sub classes that support parameters must override this method to return
* true.
*
* @return true iff this task supports command line params. * @return true iff this task supports command line params.
*/ */
public boolean supportsParams () { public boolean supportsParams () {
return false; return false;
} }
/** /**
* Set the params of this task. * Set the params of this task.
* @exception UnsupportedOperationException for tasks supporting command line parameters. *
* @exception UnsupportedOperationException
* for tasks supporting command line parameters.
*/ */
public void setParams(String params) { public void setParams(String params) {
if (!supportsParams()) { if (!supportsParams()) {