EMPIREDB-410
Javadoc fixes
diff --git a/empire-db-codegen/src/test/resources/hsqldb/sample.properties b/empire-db-codegen/src/test/resources/hsqldb/sample.properties
index 90a26a5..2ca8423 100644
--- a/empire-db-codegen/src/test/resources/hsqldb/sample.properties
+++ b/empire-db-codegen/src/test/resources/hsqldb/sample.properties
@@ -1,5 +1,5 @@
-#HSQL Database Engine 2.7.1
-#Mon Feb 27 11:12:51 CET 2023
-version=2.7.1
+#HSQL Database Engine 2.7.2
+#Fri Jun 21 16:05:49 CEST 2024
+version=2.7.2
modified=no
-tx_timestamp=396
+tx_timestamp=494
diff --git a/empire-db-codegen/src/test/resources/hsqldb/sample.script b/empire-db-codegen/src/test/resources/hsqldb/sample.script
index 849e361..02815a5 100644
--- a/empire-db-codegen/src/test/resources/hsqldb/sample.script
+++ b/empire-db-codegen/src/test/resources/hsqldb/sample.script
@@ -29,7 +29,7 @@
SET FILES NIO SIZE 256
SET FILES LOG TRUE
SET FILES LOG SIZE 50
-SET FILES CHECK 396
+SET FILES CHECK 494
SET DATABASE COLLATION "SQL_TEXT" PAD SPACE
CREATE USER SA PASSWORD DIGEST 'd41d8cd98f00b204e9800998ecf8427e'
ALTER USER SA SET LOCAL TRUE
diff --git a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java
index ac9d16c..4caa5f9 100644
--- a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java
+++ b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java
@@ -68,7 +68,7 @@
* {
* super(FacesExtensions.class);
* }
- * </pre>
+ * </pre>
*/
public class FacesConfiguration
{
@@ -107,7 +107,7 @@
/**
* Static Initializer
- * @param clazz the configuration class
+ * @param configClass the configuration class
* @param startupContext the startupContext
*/
public static <T extends FacesConfiguration> void initialize(Class<T> configClass, FacesContext startupContext, FacesImplementation facesImpl)
diff --git a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java
index fccaa42..ecaf1f6 100644
--- a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java
+++ b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java
@@ -133,7 +133,6 @@
/**
* Allows to programmatically extend the faces configuration
- * @param facesImplementation the Faces Implementation
* @param startupContext the Startup Context
*/
protected void initFacesConfiguration(FacesContext startupContext)
@@ -147,7 +146,6 @@
/**
* Creates a WebApplication instance
- * @param facesImplementation the Faces Implementation
* @param startupContext the Startup Context
* @return the WebApplication instance
*/
@@ -164,7 +162,6 @@
/**
* Initializes a WebApplication instance
* @param facesApp the WebApplication instance
- * @param facesImplementation the Faces Implementation
* @param startupContext the Startup Context
*/
protected void initWebApplication(WebApplication facesApp, FacesContext startupContext)
diff --git a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java
index c8bd7ed..41a8c3d 100644
--- a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java
+++ b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java
@@ -66,10 +66,10 @@
}
}
- /**
+ /*
* Removed with EMPIREDB-421:
*
- * public abstract <T extends DBContext> T getDBContext(DBDatabase db);
+ * public abstract T getDBContext(DBDatabase db);
*/
public String getPageName()
diff --git a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java
index c203641..24e3b83 100644
--- a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java
+++ b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java
@@ -191,7 +191,6 @@
/**
* Sets the view Metadata
* @param pageParams
- * @return
*/
protected void setPageParams(Page pageBean, Map<String, String> pageParams)
{
diff --git a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java
index b7c6abd..18a9b3e 100644
--- a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java
+++ b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java
@@ -290,7 +290,7 @@
/**
* Generates an idParam which is only valid for the given page.
- * @param targetPage the target page
+ * @param page the target page
* @param rowset the rowset
* @param key the key
* @return the encoded object
diff --git a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java
index 7cb2a7d..a3a142f 100644
--- a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java
+++ b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java
@@ -68,7 +68,7 @@
* {
* super(FacesExtensions.class);
* }
- * </pre>
+ * </pre>
*/
public class FacesConfiguration
{
@@ -107,7 +107,7 @@
/**
* Static Initializer
- * @param clazz the configuration class
+ * @param configClass the configuration class
* @param startupContext the startupContext
*/
public static <T extends FacesConfiguration> void initialize(Class<T> configClass, FacesContext startupContext, FacesImplementation facesImpl)
diff --git a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java
index fffde3c..a6c8089 100644
--- a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java
+++ b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java
@@ -133,7 +133,6 @@
/**
* Allows to programmatically extend the faces configuration
- * @param facesImplementation the Faces Implementation
* @param startupContext the Startup Context
*/
protected void initFacesConfiguration(FacesContext startupContext)
@@ -147,7 +146,6 @@
/**
* Creates a WebApplication instance
- * @param facesImplementation the Faces Implementation
* @param startupContext the Startup Context
* @return the WebApplication instance
*/
@@ -164,7 +162,6 @@
/**
* Initializes a WebApplication instance
* @param facesApp the WebApplication instance
- * @param facesImplementation the Faces Implementation
* @param startupContext the Startup Context
*/
protected void initWebApplication(WebApplication facesApp, FacesContext startupContext)
diff --git a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java
index cb530ba..e357899 100644
--- a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java
+++ b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java
@@ -66,10 +66,10 @@
}
}
- /**
+ /*
* Removed with EMPIREDB-421:
*
- * public abstract <T extends DBContext> T getDBContext(DBDatabase db);
+ * public abstract T getDBContext(DBDatabase db);
*/
public String getPageName()
diff --git a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java
index fd695ce..82b6e4f 100644
--- a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java
+++ b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java
@@ -191,7 +191,6 @@
/**
* Sets the view Metadata
* @param pageParams
- * @return
*/
protected void setPageParams(Page pageBean, Map<String, String> pageParams)
{
diff --git a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java
index aef252e..30250d2 100644
--- a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java
+++ b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java
@@ -290,7 +290,7 @@
/**
* Generates an idParam which is only valid for the given page.
- * @param targetPage the target page
+ * @param page the target page
* @param rowset the rowset
* @param key the key
* @return the encoded object
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java b/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java
index b3a3ebd..309c463 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java
@@ -25,16 +25,12 @@
import org.apache.empire.exceptions.InvalidArgumentException;
/**
- * This class is a lightweight Map<K,V> implementation using an ArrayList
- * @param <K>
- * @param <V>
+ * This class is a lightweight Map implementation using an ArrayList
*/
public class ArrayMap<K,V> extends AbstractMap<K,V>
{
/**
* The Entry class represents a map entry
- * @param <K>
- * @param <V>
*/
public static class Entry<K,V> implements Map.Entry<K, V>
{
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java b/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java
index e246c7a..2f44c64 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java
@@ -26,9 +26,7 @@
import org.apache.empire.exceptions.NotSupportedException;
/**
- * This class is a lightweight Set<E> implementation using an ArrayList
- * @param <K>
- * @param <V>
+ * This class is a lightweight Set implementation using an ArrayList
*/
public class ArraySet<E> extends ArrayList<E> implements Set<E>
{
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java b/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java
index 92bf783..57fa8c2 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java
@@ -584,7 +584,7 @@
* If the object value supplied is empty then the defValue is returned
* Numbers are considered true if they are not equal to zero
* String are considered true only if the string is "Y" or "true"
- * @param value the object to convert
+ * @param v the object to convert
* @param defValue the default value
* @return the boolean value or defValue if v is null or empty
*/
@@ -610,7 +610,7 @@
/**
* Converts an object value to a boolean.
* see getBoolean(Object v, boolean defValue) for details.
- * @param value the object to convert
+ * @param v the object to convert
* @return the boolean value or false if v is null or empty
*/
public static boolean getBoolean(Object v)
diff --git a/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java b/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java
index 42d2cf9..df14753 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java
@@ -316,9 +316,10 @@
/**
* Estimates the buffer size needed to convert an Array into a String
* @param array the array
+ * @param separatorLength the separator length
* @return the estimated length of the array parts
*/
- public static int estimateArrayBufferSize(Object[] array, int seperatorLength)
+ public static int estimateArrayBufferSize(Object[] array, int separatorLength)
{
int estimate = 0;
for (int i = 0; i < array.length; i++)
@@ -330,14 +331,14 @@
else if (item instanceof Number)
len = 10; // assume 10
else if (item instanceof Object[])
- len = estimateArrayBufferSize((Object[])item, seperatorLength);
+ len = estimateArrayBufferSize((Object[])item, separatorLength);
else if (item instanceof Collection<?>)
- len = estimateListBufferSize((Collection<?>)item, seperatorLength);
+ len = estimateListBufferSize((Collection<?>)item, separatorLength);
else if (item!=null)
len = 20; // unknown
if (len>0) {
if (estimate > 0)
- estimate += seperatorLength;
+ estimate += separatorLength;
estimate += len;
}
}
@@ -425,10 +426,11 @@
/**
* Estimates the buffer size needed to convert a Collection into a String
- * @param array the array
+ * @param list the list to estimate
+ * @param separatorLength the separator length
* @return the estimated length of the collection parts
*/
- public static int estimateListBufferSize(Collection<?> list, int seperatorLength)
+ public static int estimateListBufferSize(Collection<?> list, int separatorLength)
{
int estimate = 0;
for (Object item : list)
@@ -439,14 +441,14 @@
else if (item instanceof Number)
len = 10; // assume 10
else if (item instanceof Object[])
- len = estimateArrayBufferSize((Object[])item, seperatorLength);
+ len = estimateArrayBufferSize((Object[])item, separatorLength);
else if (item instanceof Collection<?>)
- len = estimateListBufferSize((Collection<?>)item, seperatorLength);
+ len = estimateListBufferSize((Collection<?>)item, separatorLength);
else if (item!=null)
len = 20; // unknown
if (len>0) {
if (estimate > 0)
- estimate += seperatorLength;
+ estimate += separatorLength;
estimate += len;
}
}
diff --git a/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java b/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java
index 569e828..e483930 100644
--- a/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java
+++ b/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java
@@ -215,7 +215,6 @@
}
/**
- * @Deprecated
* Use getUpdateColumn() instead!
*/
@Override
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java b/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java
index 296e52a..f33edf3 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java
@@ -106,7 +106,6 @@
public abstract DBColumn getUpdateColumn();
/**
- * @Deprecated
* Use getUpdateColumn() instead!
*/
@Override
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java b/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java
index 0b33051..64c49fb 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java
@@ -1211,7 +1211,7 @@
* Creates a SQL case expression that check whether a column or column expression is null
* "case when [condition] is null then [trueValue] else [falseValue] end"
* This is a helper function to simplify client usage
- * @param expr a column or column expression
+ * @param column a column or column expression
* @param trueValue the value to select if the condition is true
* @param falseValue the value to select if the condition is false
* @return an sql case expression
@@ -1237,7 +1237,8 @@
/**
* Creates a SQL case expression
* in the form "case [Expr] when [optionValue] then [optionText] else [elseValue] end"
- * @param Options the options to map
+ * @param column a column or column expression
+ * @param options the options to map
* @param elseValue the else expression
* @return the expression
*/
@@ -1249,8 +1250,10 @@
/**
* Creates a SQL case expression
* in the form "case [Expr] when [compareValue] then [trueValue] else [elseValue] end"
- * @param whenMap the map with constraints
- * @param elseValue the else expression
+ * @param column a column or column expression
+ * @param cmpValue the value to compare the column value with
+ * @param trueValue the true expression
+ * @param falseValue the false expression
* @return the expression
*/
public DBCaseExpr caseMap(DBColumnExpr column, Object cmpValue, Object trueValue, Object falseValue)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java
index a55841d..9b5ac80 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java
@@ -128,7 +128,7 @@
/**
* helper to check if an expression is null
- * @param value
+ * @param value the value to check
* @return true if null or false otherwise
*/
protected boolean isNull(Object value)
@@ -149,7 +149,6 @@
/**
* Init case expression.
* Must be called from all constructors!
- * @param caseExpr the case expr (if any)
* @param valueMap the value or conditions map
* @param elseValue the else value
*/
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseMapExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseMapExpr.java
index 9b8507e..07fde36 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseMapExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseMapExpr.java
@@ -52,7 +52,7 @@
/**
* constructs a DBCaseSelectExpr expr
- * @param colExpr the source column
+ * @param caseExpr the case expression
* @param valueMap the value Map
* @param elseValue the else Expression
*/
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java
index 3ef4ede..cd4bb2b 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java
@@ -65,7 +65,7 @@
* Copy and concat constructor
*
* @param joinExpr the original joinExpr
- * @param addlContraint additional constraint
+ * @param addlConstraint additional constraint
*/
public DBColumnJoinExpr(DBColumnJoinExpr joinExpr, DBCompareExpr addlConstraint)
{
diff --git a/pom.xml b/pom.xml
index 682124f..a3e21aa 100644
--- a/pom.xml
+++ b/pom.xml
@@ -114,12 +114,12 @@
</execution>
</executions>
</plugin>
- <!-- temporarily disable due to build problem -->
+ <!-- maven-javadoc-plugin: Disable checks with -Xdoclint:none -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
- <additionalparam>-Xdoclint:none</additionalparam>
+ <additionalJOption>-Xdoclint:none</additionalJOption>
</configuration>
<executions>
<execution>
@@ -177,12 +177,12 @@
</execution>
</executions>
</plugin>
- <!-- temporarily disable due to build problem -->
+ <!-- maven-javadoc-plugin: Disable checks with -Xdoclint:none -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
- <additionalparam>-Xdoclint:none</additionalparam>
+ <additionalJOption>-Xdoclint:none</additionalJOption>
</configuration>
</plugin>
</plugins>
@@ -682,8 +682,29 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
</plugin>
+
+ <!-- Generate javadoc
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <additionalJOptions>
+ <additionalJOption>-Xdoclint:all</additionalJOption>
+ <additionalJOption>-Xdoclint:-missing</additionalJOption>
+ </additionalJOptions>
+ </configuration>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ -->
+
</plugins>
-
</build>
<reporting>
@@ -766,7 +787,10 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.3</version>
+ <version>3.6.2</version>
+ <configuration>
+ <additionalJOption>-Xdoclint:none</additionalJOption>
+ </configuration>
</plugin>
-->
<!-- maven-changelog-plugin -->
