aboutsummaryrefslogtreecommitdiffstats
path: root/poi-excelant
diff options
context:
space:
mode:
authorAndreas Beeker <kiwiwings@apache.org>2021-04-14 22:53:33 +0000
committerAndreas Beeker <kiwiwings@apache.org>2021-04-14 22:53:33 +0000
commitbb5d321b79193b98051f435621f5044842716c4e (patch)
treebec508518798239131c7cdf3825d4328a7d0e831 /poi-excelant
parent7c67bba960e46433d8bf11674ef862153403cfdc (diff)
downloadpoi-bb5d321b79193b98051f435621f5044842716c4e.tar.gz
poi-bb5d321b79193b98051f435621f5044842716c4e.zip
fix javadocs - remove @author tags (http://apache-poi.1045710.n5.nabble.com/Javadocs-clean-up-remove-author-tags-tp5737663.html)
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1888780 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'poi-excelant')
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntEvaluateCell.java5
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java4
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntPrecision.java12
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSet.java18
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetDoubleCell.java12
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetFormulaCell.java18
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetStringCell.java8
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntTest.java4
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntUserDefinedFunction.java4
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/IExcelAntWorkbookHandler.java8
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntEvaluationResult.java38
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtil.java4
-rw-r--r--poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilFactory.java4
-rw-r--r--poi-excelant/src/test/java/org/apache/poi/ss/excelant/CalculateMortgageFunction.java8
-rw-r--r--poi-excelant/src/test/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilTestHelper.java5
15 files changed, 43 insertions, 109 deletions
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntEvaluateCell.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntEvaluateCell.java
index eb446dfde6..fe4109d945 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntEvaluateCell.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntEvaluateCell.java
@@ -29,11 +29,6 @@ import org.apache.tools.ant.Task;
* by a WorkbookUtil instance. The evaluate() method of the WorkbookUtil
* class returns an EvaluationResult which encapsulates the results and
* information from the evaluation.
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
-
- *
*/
public class ExcelAntEvaluateCell extends Task {
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java
index 75892aa738..23c2583da8 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java
@@ -39,10 +39,6 @@ import org.apache.tools.ant.Task;
* <code>IExcelAntWorkbookHandler</code> interface. After writing the
* class you should package it and it's dependencies into a jar file to
* add as library in your Ant build file.
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
public class ExcelAntHandlerTask extends Task {
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntPrecision.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntPrecision.java
index 0739ef5833..f6fd1446af 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntPrecision.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntPrecision.java
@@ -19,20 +19,14 @@ package org.apache.poi.ss.excelant;
import org.apache.tools.ant.taskdefs.Typedef;
-/**
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
- */
public class ExcelAntPrecision extends Typedef {
-
+
private double value ;
-
+
public void setValue( double precision ) {
value = precision ;
}
-
+
public double getValue() {
return value ;
}
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSet.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSet.java
index e62f0623d9..b8a75d5ad8 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSet.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSet.java
@@ -20,27 +20,21 @@ package org.apache.poi.ss.excelant;
import org.apache.poi.ss.excelant.util.ExcelAntWorkbookUtil;
import org.apache.tools.ant.Task;
-/**
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
- */
public abstract class ExcelAntSet extends Task {
-
+
protected String cellStr ;
-
+
protected ExcelAntWorkbookUtil wbUtil ;
-
+
public void setCell( String cellName ) {
cellStr = cellName ;
}
-
+
public String getCell() {
return cellStr ;
}
-
-
+
+
public void setWorkbookUtil( ExcelAntWorkbookUtil wb ) {
wbUtil = wb ;
}
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetDoubleCell.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetDoubleCell.java
index 2451a61e68..4908646289 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetDoubleCell.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetDoubleCell.java
@@ -23,16 +23,12 @@ import org.apache.tools.ant.Project;
/**
* Class for use in an Ant build script that sets the value of an Excel
* sheet cell using the cell id ('Sheet Name'!cellId).
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
public class ExcelAntSetDoubleCell extends ExcelAntSet {
private double cellValue;
-
+
public ExcelAntSetDoubleCell() {}
-
+
/**
* Set the value of the specified cell as the double passed in.
* @param value The double-value that should be set when this task is executed.
@@ -49,11 +45,11 @@ public class ExcelAntSetDoubleCell extends ExcelAntSet {
public double getCellValue() {
return cellValue;
}
-
+
@Override
public void execute() throws BuildException {
wbUtil.setDoubleValue(cellStr, cellValue ) ;
-
+
log( "set cell " + cellStr + " to value " + cellValue + " as double.", Project.MSG_DEBUG ) ;
}
}
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetFormulaCell.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetFormulaCell.java
index 8dc599b104..e6f2834627 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetFormulaCell.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetFormulaCell.java
@@ -23,18 +23,14 @@ import org.apache.tools.ant.Project;
/**
* Class for use in an Ant build script that sets the formula of an Excel
* sheet cell using the cell id ('Sheet Name'!cellId).
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
public class ExcelAntSetFormulaCell extends ExcelAntSet {
-
-
+
+
private String cellValue ;
-
+
public ExcelAntSetFormulaCell() {}
-
+
public void setValue( String value ) {
cellValue = value ;
}
@@ -42,12 +38,12 @@ public class ExcelAntSetFormulaCell extends ExcelAntSet {
protected String getCellValue() {
return cellValue;
}
-
+
@Override
public void execute() throws BuildException {
-
+
wbUtil.setFormulaValue( cellStr, cellValue ) ;
-
+
log( "set cell " + cellStr + " to formula " + cellValue, Project.MSG_DEBUG ) ;
}
}
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetStringCell.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetStringCell.java
index e1ab047fbf..41cae25966 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetStringCell.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntSetStringCell.java
@@ -23,10 +23,6 @@ import org.apache.tools.ant.Project;
/**
* Class for use in an Ant build script that sets the value of an Excel
* sheet cell using the cell id ('Sheet Name'!cellId).
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
public class ExcelAntSetStringCell extends ExcelAntSet {
private String stringValue ;
@@ -49,11 +45,11 @@ public class ExcelAntSetStringCell extends ExcelAntSet {
public String getCellValue() {
return stringValue;
}
-
+
@Override
public void execute() throws BuildException {
wbUtil.setStringValue(cellStr, stringValue ) ;
-
+
log( "set cell " + cellStr + " to value " + stringValue + " as String.", Project.MSG_DEBUG ) ;
}
}
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntTest.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntTest.java
index 2fd45cab15..fe7819fc41 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntTest.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntTest.java
@@ -31,10 +31,6 @@ import org.apache.tools.ant.Task;
* This class represents a single test. In order for the test any and all
* ExcelAntEvaluateCell evaluations must pass. Therefore it is recommended
* that you use only 1 evaluator but you can use more if you choose.
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
@SuppressWarnings("unused")
public class ExcelAntTest extends Task{
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntUserDefinedFunction.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntUserDefinedFunction.java
index f96a01f996..6877da5054 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntUserDefinedFunction.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/ExcelAntUserDefinedFunction.java
@@ -22,10 +22,6 @@ import org.apache.tools.ant.taskdefs.Typedef;
/**
* This class encapsulates the Strings necessary to create the User Defined
* Function instances that will be passed to POI's Evaluator instance.
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
public class ExcelAntUserDefinedFunction extends Typedef {
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/IExcelAntWorkbookHandler.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/IExcelAntWorkbookHandler.java
index c8db7008d6..b90e73fb30 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/IExcelAntWorkbookHandler.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/IExcelAntWorkbookHandler.java
@@ -21,7 +21,7 @@ import org.apache.poi.ss.usermodel.Workbook;
/**
- * In Excel there are many ways to handle manipulating a workbook based
+ * In Excel there are many ways to handle manipulating a workbook based
* on some arbitrary user action (onChange, etc). You use this interface
* to create classes that will handle the workbook in whatever manner is needed
* that cannot be handled by POI.
@@ -30,13 +30,9 @@ import org.apache.poi.ss.usermodel.Workbook;
* does some calculations and updates other cells based on that change. In
* ExcelAnt you would set the value of the cell then write your own handler
* then call that from your Ant task after the set task.
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
public interface IExcelAntWorkbookHandler {
public void setWorkbook( Workbook workbook ) ;
-
+
public void execute() ;
}
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntEvaluationResult.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntEvaluationResult.java
index 4eecd4faeb..e24952a9c5 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntEvaluationResult.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntEvaluationResult.java
@@ -20,52 +20,48 @@ package org.apache.poi.ss.excelant.util;
/**
* A simple class that encapsulates information about a cell evaluation
* from POI.
- *
- * @author Jon Svede (jon [at] loquatic [dot] com)
- * @author Brian Bush (brian [dot] bush [at] nrel [dot] gov)
- *
*/
public class ExcelAntEvaluationResult {
-
+
/**
* This boolean flag is used to determine if the evaluation completed
- * without error. This alone doesn't ensure that the evaluation was
+ * without error. This alone doesn't ensure that the evaluation was
* successful.
*/
private boolean evaluationCompletedWithError ;
-
+
/**
* This boolean flag is used to determine if the result was within
* the specified precision.
*/
private boolean didPass ;
-
+
/**
* This is the actual value returned from the evaluation.
*/
private double returnValue ;
-
+
/**
* Any error message String values that need to be returned.
*/
private String errorMessage ;
-
+
/**
* Stores the absolute value of the delta for this evaluation.
*/
private double actualDelta ;
-
+
/**
* This stores the fully qualified cell name (sheetName!cellId).
*/
private String cellName ;
-
-
+
+
public ExcelAntEvaluationResult(boolean completedWithError,
- boolean passed,
- double retValue,
- String errMessage,
+ boolean passed,
+ double retValue,
+ String errMessage,
double delta,
String cellId) {
@@ -84,19 +80,19 @@ public class ExcelAntEvaluationResult {
public String getErrorMessage() {
return errorMessage;
}
-
+
public boolean didTestPass() {
return didPass ;
}
-
+
public boolean evaluationCompleteWithError() {
return evaluationCompletedWithError ;
}
-
+
public double getDelta() {
return actualDelta ;
}
-
+
public String getCellName() {
return cellName ;
}
@@ -108,5 +104,5 @@ public class ExcelAntEvaluationResult {
+ ", returnValue=" + returnValue + ", errorMessage="
+ errorMessage + ", actualDelta=" + actualDelta + ", cellName="
+ cellName + "]";
- }
+ }
}
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtil.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtil.java
index ee3f443228..69616c5310 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtil.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtil.java
@@ -49,10 +49,6 @@ import org.apache.tools.ant.taskdefs.Typedef;
/**
* A general utility class that abstracts the POI details of loading the
* workbook, accessing and updating cells.
- *
- * @author Jon Svede (jon [at] loquatic [dot] com)
- * @author Brian Bush (brian [dot] bush [at] nrel [dot] gov)
- *
*/
public class ExcelAntWorkbookUtil extends Typedef {
diff --git a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilFactory.java b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilFactory.java
index 113f0390f7..55c4896705 100644
--- a/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilFactory.java
+++ b/poi-excelant/src/main/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilFactory.java
@@ -24,10 +24,6 @@ import java.util.Map;
/**
* This is a factory class maps file names to WorkbookUtil instances. This
* helps ExcelAnt be more efficient when being run many times in an Ant build.
- *
- * @author Jon Svede (jon [at] loquatic [dot] com)
- * @author Brian Bush (brian [dot] bush [at] nrel [dot] gov)
- *
*/
public final class ExcelAntWorkbookUtilFactory {
diff --git a/poi-excelant/src/test/java/org/apache/poi/ss/excelant/CalculateMortgageFunction.java b/poi-excelant/src/test/java/org/apache/poi/ss/excelant/CalculateMortgageFunction.java
index 73eb984db7..334079756e 100644
--- a/poi-excelant/src/test/java/org/apache/poi/ss/excelant/CalculateMortgageFunction.java
+++ b/poi-excelant/src/test/java/org/apache/poi/ss/excelant/CalculateMortgageFunction.java
@@ -26,12 +26,6 @@ import org.apache.poi.ss.formula.functions.FreeRefFunction;
/**
* A simple user-defined function to calculate principal and interest.
- *
- * Used by {@link org.apache.poi.ss.excelant.util.TestExcelAntWorkbookUtil}.
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
*/
public class CalculateMortgageFunction implements FreeRefFunction {
@@ -83,7 +77,7 @@ public class CalculateMortgageFunction implements FreeRefFunction {
/**
* Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases
*
- * @throws EvaluationException (#NUM!) if <tt>result</tt> is <tt>NaN</> or <tt>Infinity</tt>
+ * @throws EvaluationException (#NUM!) if {@code result} is {@code NaN} or {@code Infinity}
*/
private void checkValue(double result) throws EvaluationException {
if (Double.isNaN(result) || Double.isInfinite(result)) {
diff --git a/poi-excelant/src/test/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilTestHelper.java b/poi-excelant/src/test/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilTestHelper.java
index 16189f1d50..862169b91e 100644
--- a/poi-excelant/src/test/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilTestHelper.java
+++ b/poi-excelant/src/test/java/org/apache/poi/ss/excelant/util/ExcelAntWorkbookUtilTestHelper.java
@@ -22,9 +22,6 @@ import org.apache.poi.ss.usermodel.Workbook;
/**
* A helper class to allow testing of protected methods and constructors.
- *
- * @author jsvede
- *
*/
public class ExcelAntWorkbookUtilTestHelper extends ExcelAntWorkbookUtil {
@@ -46,5 +43,5 @@ public class ExcelAntWorkbookUtilTestHelper extends ExcelAntWorkbookUtil {
return super.getEvaluator(excelFileName);
}
-
+
}