[infinispan#16793] Add Spotless Maven Plugin for auto-formatting

Configure spotless-maven-plugin in pluginManagement using the Eclipse JDT
formatter backed by the project .editorconfig. Includes import ordering,
unused import removal, trailing whitespace trimming, and end-with-newline
enforcement.

Author: tristantarrant

build/bom/pom.xml

@@ -46,6 +46,7 @@
       <version.maven.gpg>3.2.8</version.maven.gpg>
       <version.maven.javadoc>3.12.0</version.maven.javadoc>
       <version.maven.sonatype.central>0.10.0</version.maven.sonatype.central>
+      <version.maven.spotless>3.2.1</version.maven.spotless>
    </properties>
 
    <dependencyManagement>
@@ -409,6 +410,31 @@
       </dependencies>
    </dependencyManagement>
 
+   <build>
+      <plugins>
+         <plugin>
+            <groupId>com.diffplug.spotless</groupId>
+            <artifactId>spotless-maven-plugin</artifactId>
+            <version>${version.maven.spotless}</version>
+            <configuration>
+               <java>
+                  <importOrder>
+                     <order>\#,java,javax,org,com,</order>
+                  </importOrder>
+                  <indent>
+                     <spaces>true</spaces>
+                     <spacesPerTab>3</spacesPerTab>
+                  </indent>
+                  <removeUnusedImports/>
+                  <trimTrailingWhitespace/>
+                  <endWithNewline/>
+                  <toggleOffOn/>
+               </java>
+            </configuration>
+         </plugin>
+      </plugins>
+   </build>
+
    <profiles>
       <profile>
          <id>community-release</id>

build/component-processor/src/main/java/org/infinispan/component/processor/AnnotationTypeValuesExtractor.java

@@ -3,6 +3,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.AnnotationValue;
 import javax.lang.model.element.ExecutableElement;

build/logging-annotations/src/main/java/org/infinispan/logging/annotations/Description.java

@@ -9,7 +9,7 @@
 
 /**
  * Description.
- * 
+ *
  * @author Durgesh Anaokar
  * @since 13.0
  */
@@ -19,9 +19,9 @@
 public @interface Description {
 
    /**
-    * 
+    *
     * Return the Description for the log message.
-    * 
+    *
     * @return String
     */
    String value();

hibernate/cache-commons/src/main/java/org/infinispan/hibernate/cache/commons/DataType.java

@@ -12,7 +12,7 @@ public enum DataType {
    COLLECTION(InfinispanProperties.COLLECTION, InfinispanProperties.DEF_ENTITY_RESOURCE, DataType::noValidation),
    IMMUTABLE_ENTITY(InfinispanProperties.IMMUTABLE_ENTITY, InfinispanProperties.DEF_ENTITY_RESOURCE, DataType::noValidation),
    TIMESTAMPS(InfinispanProperties.TIMESTAMPS, InfinispanProperties.DEF_TIMESTAMPS_RESOURCE, c -> {
-      if ( c.clustering().cacheMode().isInvalidation() ) {
+      if (c.clustering().cacheMode().isInvalidation()) {
          throw log().timestampsMustNotUseInvalidation();
       }
       if (c.memory().isEvictionEnabled()) {

hibernate/cache-commons/src/main/java/org/infinispan/hibernate/cache/commons/DefaultCacheManagerProvider.java

@@ -95,8 +95,7 @@ private static ConfigurationBuilderHolder parse(InputStream input, ClassLoader c
          // Workaround Infinispan's ClassLoader strategies to bend to our will:
          builderHolder.getGlobalConfigurationBuilder().classLoader(classLoader);
          return builderHolder;
-      }
-      finally {
+      } finally {
          currentThread.setContextClassLoader(originalClassLoader);
       }
    }

hibernate/cache-commons/src/main/java/org/infinispan/hibernate/cache/commons/JndiCacheManagerProvider.java

@@ -16,7 +16,7 @@
 
 @MetaInfServices(EmbeddedCacheManagerProvider.class)
 public class JndiCacheManagerProvider implements EmbeddedCacheManagerProvider {
-   private static final InfinispanMessageLogger log = InfinispanMessageLogger.Provider.getLog( JndiCacheManagerProvider.class );
+   private static final InfinispanMessageLogger log = InfinispanMessageLogger.Provider.getLog(JndiCacheManagerProvider.class);
 
    @Override
    public EmbeddedCacheManager getEmbeddedCacheManager(Properties properties) {

hibernate/cache-commons/src/main/java/org/infinispan/hibernate/cache/commons/access/AccessDelegate.java

@@ -9,152 +9,151 @@
  * @author Radim Vansa <rvansa@redhat.com>
  */
 public interface AccessDelegate {
-	Object get(Object session, Object key, long txTimestamp) throws CacheException;
+   Object get(Object session, Object key, long txTimestamp) throws CacheException;
 
-	/**
-	 * Attempt to cache an object, after loading from the database.
-	 *
-	 * @param session Current session
-	 * @param key The item key
-	 * @param value The item
-	 * @param txTimestamp a timestamp prior to the transaction start time
-	 * @param version the item version number
-	 * @return <code>true</code> if the object was successfully cached
-	 */
-	boolean putFromLoad(Object session, Object key, Object value, long txTimestamp, Object version);
+   /**
+    * Attempt to cache an object, after loading from the database.
+    *
+    * @param session     Current session
+    * @param key         The item key
+    * @param value       The item
+    * @param txTimestamp a timestamp prior to the transaction start time
+    * @param version     the item version number
+    * @return <code>true</code> if the object was successfully cached
+    */
+   boolean putFromLoad(Object session, Object key, Object value, long txTimestamp, Object version);
 
-	/**
-	 * Attempt to cache an object, after loading from the database, explicitly
-	 * specifying the minimalPut behavior.
-	 *
-	 * @param session Current session.
-	 * @param key The item key
-	 * @param value The item
-	 * @param txTimestamp a timestamp prior to the transaction start time
-	 * @param version the item version number
-	 * @param minimalPutOverride Explicit minimalPut flag
-	 * @return <code>true</code> if the object was successfully cached
-	 * @throws org.hibernate.cache.CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
-	 */
-	boolean putFromLoad(Object session, Object key, Object value, long txTimestamp, Object version, boolean minimalPutOverride)
-			throws CacheException;
+   /**
+    * Attempt to cache an object, after loading from the database, explicitly
+    * specifying the minimalPut behavior.
+    *
+    * @param session            Current session.
+    * @param key                The item key
+    * @param value              The item
+    * @param txTimestamp        a timestamp prior to the transaction start time
+    * @param version            the item version number
+    * @param minimalPutOverride Explicit minimalPut flag
+    * @return <code>true</code> if the object was successfully cached
+    * @throws org.hibernate.cache.CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
+    */
+   boolean putFromLoad(Object session, Object key, Object value, long txTimestamp, Object version, boolean minimalPutOverride)
+         throws CacheException;
 
-	/**
-	 * Called after an item has been inserted (before the transaction completes),
-	 * instead of calling evict().
-	 *
-	 * @param session Current session
-	 * @param key The item key
-	 * @param value The item
-	 * @param version The item's version value
-	 * @return Were the contents of the cache actual changed by this operation?
-	 * @throws CacheException if the insert fails
-	 */
-	boolean insert(Object session, Object key, Object value, Object version) throws CacheException;
+   /**
+    * Called after an item has been inserted (before the transaction completes),
+    * instead of calling evict().
+    *
+    * @param session Current session
+    * @param key     The item key
+    * @param value   The item
+    * @param version The item's version value
+    * @return Were the contents of the cache actual changed by this operation?
+    * @throws CacheException if the insert fails
+    */
+   boolean insert(Object session, Object key, Object value, Object version) throws CacheException;
 
-	/**
-	 * Called after an item has been updated (before the transaction completes),
-	 * instead of calling evict().
-	 *
-	 * @param session Current session
-	 * @param key The item key
-	 * @param value The item
-	 * @param currentVersion The item's current version value
-	 * @param previousVersion The item's previous version value
-	 * @return Whether the contents of the cache actual changed by this operation
-	 * @throws CacheException if the update fails
-	 */
-	boolean update(Object session, Object key, Object value, Object currentVersion, Object previousVersion)
-			throws CacheException;
+   /**
+    * Called after an item has been updated (before the transaction completes),
+    * instead of calling evict().
+    *
+    * @param session         Current session
+    * @param key             The item key
+    * @param value           The item
+    * @param currentVersion  The item's current version value
+    * @param previousVersion The item's previous version value
+    * @return Whether the contents of the cache actual changed by this operation
+    * @throws CacheException if the update fails
+    */
+   boolean update(Object session, Object key, Object value, Object currentVersion, Object previousVersion)
+         throws CacheException;
 
-	/**
-	 * Called after an item has become stale (before the transaction completes).
-	 *
-	 * @param session Current session
-	 * @param key The key of the item to remove
-	 * @throws CacheException if removing the cached item fails
-	 */
-	void remove(Object session, Object key) throws CacheException;
+   /**
+    * Called after an item has become stale (before the transaction completes).
+    *
+    * @param session Current session
+    * @param key     The key of the item to remove
+    * @throws CacheException if removing the cached item fails
+    */
+   void remove(Object session, Object key) throws CacheException;
 
-	/**
-	 * Called just before the delegate will have all entries removed. Any work to prevent concurrent modifications
-	 * while this occurs should happen here
-	 * @throws CacheException if locking had an issue
-	 */
-	void lockAll() throws CacheException;
+   /**
+    * Called just before the delegate will have all entries removed. Any work to prevent concurrent modifications
+    * while this occurs should happen here
+    *
+    * @throws CacheException if locking had an issue
+    */
+   void lockAll() throws CacheException;
 
-	/**
-	 * Called just after the delegate had all entries removed via {@link #removeAll()}. Any work required to allow
-	 * for new modifications to happen should be done here
-	 * @throws CacheException if unlocking had an issue
-	 */
-	void unlockAll() throws CacheException;
+   /**
+    * Called just after the delegate had all entries removed via {@link #removeAll()}. Any work required to allow
+    * for new modifications to happen should be done here
+    *
+    * @throws CacheException if unlocking had an issue
+    */
+   void unlockAll() throws CacheException;
 
-	/**
-	 * Called to evict data from the entire region
-	 *
-	 * @throws CacheException if eviction the region fails
-	 */
-	void removeAll() throws CacheException;
+   /**
+    * Called to evict data from the entire region
+    *
+    * @throws CacheException if eviction the region fails
+    */
+   void removeAll() throws CacheException;
 
-	/**
-	 * Forcibly evict an item from the cache immediately without regard for transaction
-	 * isolation.
-	 *
-	 * @param key The key of the item to remove
-	 * @throws CacheException if evicting the item fails
-	 */
-	void evict(Object key) throws CacheException;
+   /**
+    * Forcibly evict an item from the cache immediately without regard for transaction
+    * isolation.
+    *
+    * @param key The key of the item to remove
+    * @throws CacheException if evicting the item fails
+    */
+   void evict(Object key) throws CacheException;
 
-	/**
-	 * Forcibly evict all items from the cache immediately without regard for transaction
-	 * isolation.
-	 *
-	 * @throws CacheException if evicting items fails
-	 */
-	void evictAll() throws CacheException;
+   /**
+    * Forcibly evict all items from the cache immediately without regard for transaction
+    * isolation.
+    *
+    * @throws CacheException if evicting items fails
+    */
+   void evictAll() throws CacheException;
 
-	/**
-	 * Called when we have finished the attempted update/delete (which may or
-	 * may not have been successful), after transaction completion.  This method
-	 * is used by "asynchronous" concurrency strategies.
-	 *
-	 *
-	 * @param session
-	 * @param key The item key
-	 * @throws org.hibernate.cache.CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
-	 */
-	void unlockItem(Object session, Object key) throws CacheException;
+   /**
+    * Called when we have finished the attempted update/delete (which may or
+    * may not have been successful), after transaction completion.  This method
+    * is used by "asynchronous" concurrency strategies.
+    *
+    * @param session
+    * @param key     The item key
+    * @throws org.hibernate.cache.CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
+    */
+   void unlockItem(Object session, Object key) throws CacheException;
 
-	/**
-	 * Called after an item has been inserted (after the transaction completes),
-	 * instead of calling release().
-	 * This method is used by "asynchronous" concurrency strategies.
-	 *
-	 *
-	 * @param session
-	 * @param key The item key
-	 * @param value The item
-	 * @param version The item's version value
-	 * @return Were the contents of the cache actual changed by this operation?
-	 * @throws CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
-	 */
-	boolean afterInsert(Object session, Object key, Object value, Object version);
+   /**
+    * Called after an item has been inserted (after the transaction completes),
+    * instead of calling release().
+    * This method is used by "asynchronous" concurrency strategies.
+    *
+    * @param session
+    * @param key     The item key
+    * @param value   The item
+    * @param version The item's version value
+    * @return Were the contents of the cache actual changed by this operation?
+    * @throws CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
+    */
+   boolean afterInsert(Object session, Object key, Object value, Object version);
 
-	/**
-	 * Called after an item has been updated (after the transaction completes),
-	 * instead of calling release().  This method is used by "asynchronous"
-	 * concurrency strategies.
-	 *
-	 *
-	 * @param session
-	 * @param key The item key
-	 * @param value The item
-	 * @param currentVersion The item's current version value
-	 * @param previousVersion The item's previous version value
-	 * @param lock The lock
-	 * @return Were the contents of the cache actual changed by this operation?
-	 * @throws CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
-	 */
-	boolean afterUpdate(Object session, Object key, Object value, Object currentVersion, Object previousVersion, SoftLock lock);
+   /**
+    * Called after an item has been updated (after the transaction completes),
+    * instead of calling release().  This method is used by "asynchronous"
+    * concurrency strategies.
+    *
+    * @param session
+    * @param key             The item key
+    * @param value           The item
+    * @param currentVersion  The item's current version value
+    * @param previousVersion The item's previous version value
+    * @param lock            The lock
+    * @return Were the contents of the cache actual changed by this operation?
+    * @throws CacheException Propagated from underlying {@link org.hibernate.cache.spi.Region}
+    */
+   boolean afterUpdate(Object session, Object key, Object value, Object currentVersion, Object previousVersion, SoftLock lock);
 }