javadoc fixes

eclipse-dirigible · Dec 27, 2019 · a3bb0a9 · a3bb0a9
1 parent 4213901
commit a3bb0a9
Show file tree

Hide file tree

Showing 10 changed files with 111 additions and 30 deletions.
diff --git a/...es/database/database-sql/src/main/java/org/eclipse/dirigible/database/sql/SqlFactory.java b/...es/database/database-sql/src/main/java/org/eclipse/dirigible/database/sql/SqlFactory.java
@@ -39,10 +39,14 @@
  *            the generic type
  * @param <CREATE>
  *            the generic type
+ * @param <ALTER>
+ *            the generic type
  * @param <DROP>
  *            the generic type
  * @param <NEXT>
  *            the generic type
+ * @param <LAST>
+ *            the generic type
  */
 public class SqlFactory<SELECT extends SelectBuilder, INSERT extends InsertBuilder, UPDATE extends UpdateBuilder, DELETE extends DeleteBuilder, CREATE extends CreateBranchingBuilder, ALTER extends AlterBranchingBuilder, DROP extends DropBranchingBuilder, NEXT extends NextValueSequenceBuilder, LAST extends LastValueIdentityBuilder>
 		implements ISqlFactory<SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, NEXT, LAST> {
@@ -72,10 +76,14 @@ public static SqlFactory getDefault() {
 	 *            the generic type
 	 * @param <CREATE>
 	 *            the generic type
+	 * @param <ALTER>
+     *            the generic type
 	 * @param <DROP>
 	 *            the generic type
 	 * @param <NEXT>
 	 *            the generic type
+	 * @param <LAST>
+	 *            the generic type
 	 * @param dialect
 	 *            the dialect
 	 * @return the native

diff --git a/...c/main/java/org/eclipse/dirigible/database/sql/builders/synonym/CreateSynonymBuilder.java b/...c/main/java/org/eclipse/dirigible/database/sql/builders/synonym/CreateSynonymBuilder.java
@@ -41,10 +41,10 @@ public CreateSynonymBuilder(ISqlDialect dialect, String synonym) {
 	}
 
 	/**
-	 * Start.
+	 * Source.
 	 *
-	 * @param start
-	 *            the start
+	 * @param source
+	 *            the source
 	 * @return the creates the synonym builder
 	 */
 	public CreateSynonymBuilder forSource(String source) {

diff --git a/...java/org/eclipse/dirigible/database/sql/dialects/derby/DerbyLastValueIdentityBuilder.java b/...java/org/eclipse/dirigible/database/sql/dialects/derby/DerbyLastValueIdentityBuilder.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2010-2018 SAP and others.
+ * Copyright (c) 2010-2019 SAP and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -29,6 +29,8 @@ public class DerbyLastValueIdentityBuilder extends LastValueIdentityBuilder {
 	 *
 	 * @param dialect
 	 *            the dialect
+	 * @param args
+	 *            the args
 	 */
 	public DerbyLastValueIdentityBuilder(ISqlDialect dialect, String... args) {
 		super(dialect);

diff --git a/...n/java/org/eclipse/dirigible/database/sql/dialects/hana/HanaLastValueIdentityBuilder.java b/...n/java/org/eclipse/dirigible/database/sql/dialects/hana/HanaLastValueIdentityBuilder.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2010-2018 SAP and others.
+ * Copyright (c) 2010-2019 SAP and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -29,6 +29,8 @@ public class HanaLastValueIdentityBuilder extends LastValueIdentityBuilder {
 	 *
 	 * @param dialect
 	 *            the dialect
+	 * @param args
+	 *            the args
 	 */
 	public HanaLastValueIdentityBuilder(ISqlDialect dialect, String... args) {
 		super(dialect);

diff --git a/...engine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/api/IODataCoreService.java b/...engine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/api/IODataCoreService.java
@@ -170,7 +170,7 @@ public interface IODataCoreService extends ICoreService {
 	 * Generates the EDMX Metadata
 	 * 
 	 * @return the metadata
-	 * @throws ODataException 
+	 * @throws ODataException in case of an error
 	 */
 	public InputStream getMetadata() throws ODataException;
 

diff --git a/.../engine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/sql/api/SQLProcessor.java b/.../engine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/sql/api/SQLProcessor.java
@@ -24,15 +24,27 @@
 
 public interface SQLProcessor extends ODataProcessor {
 
+	/**
+     * Getter for the default data source
+     * @return the default data source
+     */
+    DataSource getDataSource();
+
+
+    /**
+     * Getter for the default sql builder
+     * @return the default sql builder
+     */
+    SQLQueryBuilder getSQLQueryBuilder();
+
     /**
      * This callback method can be used to customize the property value that is
      * being written. The default implementation returns the provided value.
      * Note that this method is dependent on the sequence of the property in the
-     * entity. If this property depends on other properties, consider using
-     * {@link #onCustomizeEntityInstance(EdmEntityType, Object)}
+     * entity. If this property depends on other properties
      * 
      * 
-     * @param entityType
+     * @param entityType edm entity type
      * @param property
      *            EDM property of the model that is currently being filled with
      *            data.
@@ -44,17 +56,20 @@ public interface SQLProcessor extends ODataProcessor {
      *            property is not mapped to DB.
      * @return the customized property value. If you do not customize then just
      *         return the <code>value</code>
-     * @throws ODataException
+     * @throws EdmException in case of an error
      */
-
-    DataSource getDataSource();
-
     Object onCustomizePropertyValue(EdmStructuralType entityType, EdmProperty property, Object entityInstance, Object value)
             throws EdmException;
+
 
-
-    SQLQueryBuilder getSQLQueryBuilder();
-
+    /**
+     * 
+     * @param entityType the entity type
+     * @param expandType the expand type
+     * @param expandInstance the expand instance
+     * @return the customized navigation property
+     * @throws EdmException in case of an error
+     */
     Map<String, Object> onCustomizeExpandedNavigatonProperty(EdmStructuralType entityType, EdmStructuralType expandType,
             Map<String, Object> expandInstance) throws EdmException;
 

diff --git a/.../engine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/sql/builder/EdmUtils.java b/.../engine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/sql/builder/EdmUtils.java
@@ -50,11 +50,11 @@ private EdmUtils() {
      * Properties of Entity in the items but NOT NavigationPaths or '*' terms.
      * Both cases are considered NOT IMPLEMENTED and will yield an exception
      * 
-     * @param selectedItems
-     * @param entityType
-     * @return
-     * @throws EdmException
-     * @throws ODataNotImplementedException
+     * @param selectedItems the selected items
+     * @param entityType the entity type
+     * @return the selected properties
+     * @throws EdmException in case of an edm error
+     * @throws ODataNotImplementedException in case of missing feature
      */
     public static Collection<EdmProperty> getSelectedProperties(List<SelectItem> selectedItems, EdmStructuralType entityType)
             throws EdmException, ODataNotImplementedException {
@@ -96,7 +96,11 @@ public static Collection<EdmProperty> getProperties(EdmStructuralType entityType
      * not-selected key properties are returned</li>
      * </ul>
      * 
-     * @throws ODataNotImplementedException
+     * @param selectedItems the selected items
+     * @param type the edm type
+     * @return the list of the selected property names
+     * @throws EdmException in case of an edm error
+     * @throws ODataNotImplementedException in case of a missing feature
      */
     public static Collection<String> getSelectedPropertyNames(List<SelectItem> selectedItems, EdmStructuralType type)
             throws EdmException, ODataNotImplementedException {
@@ -143,8 +147,8 @@ private static Set<String> getSelectedPropertyNames(List<SelectItem> selectedPro
      * This method evaluates the expression based on the type instance. Used for
      * adding escape characters where necessary.
      * 
-     * @param value
-     * @param edmSimpleType
+     * @param value the datetime instance
+     * @param edmSimpleType edm type
      * @return the evaluated expression
      */
     public static Object evaluateDateTimeExpressions(Object value, final EdmSimpleType edmSimpleType) {

diff --git a/...ngine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/sql/builder/SQLContext.java b/...ngine-odata/src/main/java/org/eclipse/dirigible/engine/odata2/sql/builder/SQLContext.java
@@ -51,12 +51,15 @@ public SQLContext(final DatabaseMetaData metadata, final ODataContext odataConte
     }
 
     /**
-     * @param postgreSql
+     * @param databaseProduct the database product name
      */
     public SQLContext(final DatabaseProduct databaseProduct) {
         this.databaseProduct = databaseProduct;
     }
 
+    /**
+     * @return the database product
+     */
     public DatabaseProduct getDatabaseProduct() {
         return databaseProduct;
     }

diff --git a/pom.xml b/pom.xml
@@ -91,6 +91,29 @@
 							<debuglevel>lines,vars,source</debuglevel>
 						</configuration>
 					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-javadoc-plugin</artifactId>
+						<version>3.1.1</version>
+						<executions>
+							<execution>
+								<id>attach-javadocs</id>
+								<goals>
+									<goal>jar</goal>
+								</goals>
+							</execution>
+						</executions>
+						<!-- <configuration>
+							<failOnError>false</failOnError>
+						</configuration> -->
+						<dependencies>
+							<dependency>
+							    <groupId>org.apache.commons</groupId>
+							    <artifactId>commons-lang3</artifactId>
+							    <version>${commons.lang3}</version>
+							</dependency>
+						</dependencies>
+					</plugin>
 				</plugins>
 			</build>
 		</profile>
@@ -250,7 +273,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-compiler-plugin</artifactId>
-						<version>2.4</version>
+						<version>3.8.1</version>
 						<configuration>
 							<source>${java.version}</source>
 							<target>${java.version}</target>
@@ -261,7 +284,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-source-plugin</artifactId>
-						<version>2.2.1</version>
+						<version>3.2.0</version>
 						<executions>
 							<execution>
 								<id>attach-sources</id>
@@ -274,7 +297,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-javadoc-plugin</artifactId>
-						<version>2.9.1</version>
+						<version>3.1.1</version>
 						<executions>
 							<execution>
 								<id>attach-javadocs</id>
@@ -283,6 +306,16 @@
 								</goals>
 							</execution>
 						</executions>
+						<!-- <configuration>
+							<failOnError>false</failOnError>
+						</configuration> -->
+						<dependencies>
+							<dependency>
+							    <groupId>org.apache.commons</groupId>
+							    <artifactId>commons-lang3</artifactId>
+							    <version>${commons.lang3}</version>
+							</dependency>
+						</dependencies>
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
@@ -421,6 +454,11 @@
 			<version>${jsr250-api.version}</version>
 		</dependency>
 
+        <dependency>
+		    <groupId>org.apache.commons</groupId>
+		    <artifactId>commons-lang3</artifactId>
+		    <version>${commons.lang3}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.apache.cxf</groupId>
 			<artifactId>cxf-rt-rs-service-description-swagger</artifactId>
@@ -494,7 +532,8 @@
 		<maven.scm.plugin.version>1.9</maven.scm.plugin.version>
 		<commons.io>2.6</commons.io>
 		<commons.codec>1.10</commons.codec>
-		<cxf.version>3.1.11</cxf.version>
+		<commons.lang3>3.9</commons.lang3>
+		<cxf.version>3.3.4</cxf.version>
 		<gson.version>2.2.4</gson.version>
 		<guice.version>4.2.2</guice.version>
 		<mockito.version>2.23.0</mockito.version>

diff --git a/releng/embedded-all/pom.xml b/releng/embedded-all/pom.xml
@@ -29,7 +29,7 @@
 
 			<plugin>
 		        <artifactId>maven-javadoc-plugin</artifactId>
-		        <version>3.0.1</version>
+		        <version>3.1.1</version>
 		        <executions>
 		          <execution>
 		            <id>javadoc-jar</id>
@@ -39,9 +39,17 @@
 		            </goals>
 		            <configuration>
 		              <includeDependencySources>false</includeDependencySources>
+		              <failOnError>false</failOnError>
 		            </configuration>
 		          </execution>
 		        </executions>
+		        <dependencies>
+					<dependency>
+					    <groupId>org.apache.commons</groupId>
+					    <artifactId>commons-lang3</artifactId>
+					    <version>${commons.lang3}</version>
+					</dependency>
+				</dependencies>
 		      </plugin>
 
 			<plugin>