Merge Hibernate Tools into ORM : Update the Reverse Engineering module to respect the coding rules

Author: koentsje

tooling/hibernate-reveng/hibernate-reveng.gradle

@@ -1,14 +1,14 @@
 plugins {
-    id "local.java-module"
+    id "local.publishing-java-module"
 }
 
 description = "Library providing functionality to perform reverse engineering Hibernate related artefacts from an existing database"
 
 dependencies {
     implementation project( ':hibernate-core' )
-//    implementation project( ':hibernate-ant' )
     implementation "org.apache.commons:commons-collections4:4.5.0"
     implementation "com.google.googlejavaformat:google-java-format:1.27.0"
     implementation "org.freemarker:freemarker:2.3.34"
     implementation "org.antlr:antlr4-runtime:4.13.2"
-}
+}
+

tooling/hibernate-reveng/src/main/java/org/hibernate/tool/reveng/api/core/AssociationInfo.java

@@ -1,27 +1,14 @@
 /*
- * Hibernate Tools, Tooling for your Hibernate Projects
- *
- * Copyright 2010-2025 Red Hat, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
  */
 package org.hibernate.tool.reveng.api.core;
 
 public interface AssociationInfo {
 
-		String getCascade();	
-		String getFetch();		
+		String getCascade();
+		String getFetch();
 		Boolean getUpdate();
-		Boolean getInsert();					
+		Boolean getInsert();
 
 }

tooling/hibernate-reveng/src/main/java/org/hibernate/tool/reveng/api/core/RevengDialect.java

@@ -1,19 +1,6 @@
 /*
- * Hibernate Tools, Tooling for your Hibernate Projects
- *
- * Copyright 2010-2025 Red Hat, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
  */
 package org.hibernate.tool.reveng.api.core;
 
@@ -26,28 +13,28 @@
  * Interface for fetching metadata from databases.
  * The dialect is configured with a ConnectionProvider but is not
  * required to actually use any connections.
- * 
+ *
  * The metadata methods all returns Iterator and allows for more efficient and partial reads
- * for those databases that has "flakey" JDBC metadata implementions. 
- *  
+ * for those databases that has "flakey" JDBC metadata implementions.
+ *
  * @author Max Rydahl Andersen
  *
  */
 public interface RevengDialect {
 
 	/**
-	 * Configure the metadatadialect. 
-	 * @param connectionProvider a {@link ConnectionProvider} 
+	 * Configure the metadatadialect.
+	 * @param connectionProvider a {@link ConnectionProvider}
 	 */
 	public void configure(ConnectionProvider connectionProvider);
-	
-	/** 
+
+	/**
 	 * Return iterator over the tables that mathces catalog, schema and table
-	 * 
+	 *
 	 * @param catalog name or null
 	 * @param schema name or null
-	 * @param table name or null 
-	 * @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "TABLE_TYPE" keys. 
+	 * @param table name or null
+	 * @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "TABLE_TYPE" keys.
 	 */
 	Iterator<Map<String,Object>> getTables(String catalog, String schema, String table);
 
@@ -57,19 +44,19 @@ public interface RevengDialect {
 	 */
 	void close(Iterator<?> iterator);
 
-	/** 
+	/**
 	 * Return iterator over the indexes that mathces catalog, schema and table
-	 * 
+	 *
 	 * @param catalog name or null
 	 * @param schema name or null
-	 * @param table name or null 
-	 * @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "INDEX_NAME", "COLUMN_NAME", "NON_UNIQUE", "TYPE" keys. 
+	 * @param table name or null
+	 * @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "INDEX_NAME", "COLUMN_NAME", "NON_UNIQUE", "TYPE" keys.
 	 */
 	Iterator<Map<String, Object>> getIndexInfo(String catalog, String schema, String table);
 
 	/**
 	 * Return iterator over the columns that mathces catalog, schema and table
-	 * 
+	 *
 	 * @param catalog name or null
 	 * @param schema name or null
 	 * @param table name or null
@@ -80,7 +67,7 @@ public interface RevengDialect {
 
 	/**
 	 * Return iterator over the columns that mathces catalog, schema and table
-	 * 
+	 *
 	 * @param catalog name or null
 	 * @param schema name or null
 	 * @param table name or null
@@ -91,7 +78,7 @@ public interface RevengDialect {
 
 	/**
 	 * Return iterator over the exported foreign keys that mathces catalog, schema and table
-	 * 
+	 *
 	 * @param catalog name or null
 	 * @param schema name or null
 	 * @param table name or null
@@ -101,26 +88,26 @@ public interface RevengDialect {
 
 	/**
 	 * Does this name need quoting
-	 * 
+	 *
 	 * @param name
 	 * @return
 	 */
 	boolean needQuote(String name);
-	
+
 	/**
 	 * Close any resources this dialect might have used.
 	 */
 	void close();
 
 	/**
-	 * Use database (possible native) metadata to suggest identifier strategy. 
-	 * 
+	 * Use database (possible native) metadata to suggest identifier strategy.
+	 *
 	 * @param catalog
 	 * @param schema
 	 * @param name
 	 * @return iterator with map elements that has "TABLE_NAME", "TABLE_SCHEMA", "TABLE_CAT", "HIBERNATE_STRATEGY" (null if no possible to determine strategy, otherwise return hibernate identifier strategy name/classname)
 	 */
 	public Iterator<Map<String, Object>> getSuggestedPrimaryKeyStrategyName(String catalog, String schema, String table);
 
-	
+
 }

tooling/hibernate-reveng/src/main/java/org/hibernate/tool/reveng/api/core/RevengDialectFactory.java

@@ -1,19 +1,6 @@
 /*
- * Hibernate Tools, Tooling for your Hibernate Projects
- *
- * Copyright 2010-2025 Red Hat, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
  */
 package org.hibernate.tool.reveng.api.core;
 
@@ -35,7 +22,7 @@
 import java.util.Properties;
 
 public class RevengDialectFactory {
-	
+
 	private RevengDialectFactory() {}
 
 	public static RevengDialect createMetaDataDialect(Dialect dialect, Properties cfg) {
@@ -56,7 +43,7 @@ public static RevengDialect createMetaDataDialect(Dialect dialect, Properties cf
 	public static RevengDialect fromClassName(String property) {
 		if ( property != null ) {
 			try {
-				Class<?> revengDialectClass = ReflectHelper.classForName( 
+				Class<?> revengDialectClass = ReflectHelper.classForName(
 						property,
 						RevengDialectFactory.class );
 				Constructor<?> revengDialectConstructor = revengDialectClass.getConstructor(
@@ -67,28 +54,33 @@ public static RevengDialect fromClassName(String property) {
 				throw new RuntimeException(
 						"Could not load MetaDataDialect: " + property, e );
 			}
-		} else {
+		}
+		else {
 			return null;
 		}
 	}
-	
+
 	public static RevengDialect fromDialect(Dialect dialect) {
-		if(dialect!=null) {  
+		if(dialect!=null) {
 			if(dialect instanceof OracleDialect) {
 				return new OracleMetaDataDialect();
-			} else if (dialect instanceof H2Dialect) {
+			}
+			else if (dialect instanceof H2Dialect) {
 				return new H2MetaDataDialect();
-			} else if (dialect instanceof MySQLDialect) {
+			}
+			else if (dialect instanceof MySQLDialect) {
 				return new MySQLMetaDataDialect();
-			} else if (dialect instanceof HSQLDialect) {
+			}
+			else if (dialect instanceof HSQLDialect) {
 				return new HSQLMetaDataDialect();
-			}else if (dialect instanceof SQLServerDialect) {
+			}
+			else if (dialect instanceof SQLServerDialect) {
 				return new SQLServerMetaDataDialect();
-			}			
+			}
 		}
 		return null;
 	}
-	
+
 	public static RevengDialect fromDialectName(String dialect) {
 		if (dialect.toLowerCase().contains("oracle")) {
 			return new OracleMetaDataDialect();

tooling/hibernate-reveng/src/main/java/org/hibernate/tool/reveng/api/core/RevengSettings.java

@@ -1,58 +1,46 @@
 /*
- * Hibernate Tools, Tooling for your Hibernate Projects
- *
- * Copyright 2010-2025 Red Hat, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
  */
 package org.hibernate.tool.reveng.api.core;
 
 public class RevengSettings {
 
-	
+
 	final RevengStrategy rootStrategy;
-	
+
 	private String defaultPackageName = "";
 	private boolean detectOptimisticLock = true;
 	private boolean createCollectionForForeignKey = true;
 	private boolean createManyToOneForForeignKey = true;
 	private boolean detectManyToMany = true;
 	private boolean detectOneToOne = true;
 
-	
+
 	public RevengSettings(RevengStrategy rootStrategy) {
 		this.rootStrategy = rootStrategy;
 	}
-	
+
 	public RevengSettings setDefaultPackageName(String defaultPackageName) {
 		if(defaultPackageName==null) {
 			this.defaultPackageName = "";
-		} else {
+		}
+		else {
 			this.defaultPackageName= defaultPackageName.trim();
 		}
 		return this;
 	}
-	
+
 	/** return the default packageName. Never null, at least the empty string */
 	public String getDefaultPackageName() {
 		return defaultPackageName;
 	}
-	
+
 	/** If true, reverse engineering strategy will try and autodetect columns for optimistc locking, e.g. VERSION and TIMESTAMP */
 	public boolean getDetectOptimsticLock() {
 		return detectOptimisticLock ;
 	}
-	
+
 	public RevengSettings setDetectOptimisticLock(
 			boolean optimisticLockSupportEnabled) {
 		this.detectOptimisticLock = optimisticLockSupportEnabled;
@@ -63,8 +51,8 @@ public RevengSettings setDetectOptimisticLock(
 	public boolean createCollectionForForeignKey() {
 		return createCollectionForForeignKey;
 	}
-	
-	
+
+
 	public RevengSettings setCreateCollectionForForeignKey(
 			boolean createCollectionForForeignKey) {
 		this.createCollectionForForeignKey = createCollectionForForeignKey;
@@ -75,7 +63,7 @@ public RevengSettings setCreateCollectionForForeignKey(
 	public boolean createManyToOneForForeignKey() {
 		return createManyToOneForForeignKey;
 	}
-	
+
 	public RevengSettings setCreateManyToOneForForeignKey(
 			boolean createManyToOneForForeignKey) {
 		this.createManyToOneForForeignKey = createManyToOneForForeignKey;
@@ -86,11 +74,11 @@ public RevengSettings setDetectManyToMany(boolean b) {
 		this.detectManyToMany = b;
 		return this;
 	}
-	
+
 	public boolean getDetectManyToMany() {
 		return detectManyToMany;
 	}
-	
+
 	public RevengSettings setDetectOneToOne(boolean b) {
 		this.detectOneToOne = b;
 		return this;
@@ -99,12 +87,12 @@ public RevengSettings setDetectOneToOne(boolean b) {
 	public boolean getDetectOneToOne() {
 		return detectOneToOne;
 	}
-	
+
 	/** return the top/root strategy. Allows a lower strategy to ask another question. Be aware of possible recursive loops; e.g. do not call the root.tableToClassName in tableToClassName of a custom reversengineeringstrategy. */
 	public RevengStrategy getRootStrategy() {
 		return rootStrategy;
 	}
 
-	
-	
+
+
 }