add some Javadoc, fix warning, and remove some minor junk

gavinking · gavinking · commit 11f784e23b49 · 2022-02-03T19:10:45.000+01:00
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/CacheRegionDefinition.java b/hibernate-core/src/main/java/org/hibernate/boot/CacheRegionDefinition.java
@@ -17,7 +17,7 @@
  * @author Steve Ebersole
  */
 public class CacheRegionDefinition {
-	public static enum CacheRegionType {
+	public enum CacheRegionType {
 		ENTITY,
 		COLLECTION,
 		QUERY
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/InvalidMappingException.java b/hibernate-core/src/main/java/org/hibernate/boot/InvalidMappingException.java
@@ -9,6 +9,8 @@
 import org.hibernate.boot.jaxb.Origin;
 
 /**
+ * Indicates a problem parsing the mapping document at a given {@link Origin}.
+ *
  * @author Brett Meyer
  */
 public class InvalidMappingException extends org.hibernate.InvalidMappingException {
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/MappingNotFoundException.java b/hibernate-core/src/main/java/org/hibernate/boot/MappingNotFoundException.java
@@ -9,6 +9,8 @@
 import org.hibernate.boot.jaxb.Origin;
 
 /**
+ * Indicates that a mapping document could not be found at a given {@link Origin}.
+ *
  * @author Steve Ebersole
  */
 public class MappingNotFoundException extends MappingException {
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/SchemaAutoTooling.java b/hibernate-core/src/main/java/org/hibernate/boot/SchemaAutoTooling.java
@@ -10,7 +10,7 @@
 import org.hibernate.cfg.AvailableSettings;
 
 /**
- * Defines the possible values for "hbm2ddl_auto"
+ * Defines the possible values for {@value AvailableSettings#HBM2DDL_AUTO}.
  *
  * @author Steve Ebersole
  */
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/SessionFactoryBuilder.java b/hibernate-core/src/main/java/org/hibernate/boot/SessionFactoryBuilder.java
@@ -31,7 +31,6 @@
  *
  * @since 5.0
  */
-@SuppressWarnings("UnusedReturnValue")
 public interface SessionFactoryBuilder {
 	/**
 	 * Specifies a Bean Validation {@link jakarta.validation.ValidatorFactory}.
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/UnsupportedOrmXsdVersionException.java b/hibernate-core/src/main/java/org/hibernate/boot/UnsupportedOrmXsdVersionException.java
@@ -19,7 +19,6 @@ public UnsupportedOrmXsdVersionException(String requestedVersion, Origin origin)
 		this.requestedVersion = requestedVersion;
 	}
 
-	@SuppressWarnings("UnusedDeclaration")
 	public String getRequestedVersion() {
 		return requestedVersion;
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/cfgxml/internal/ConfigLoader.java b/hibernate-core/src/main/java/org/hibernate/boot/cfgxml/internal/ConfigLoader.java
@@ -34,8 +34,8 @@ public class ConfigLoader {
 
 	private final BootstrapServiceRegistry bootstrapServiceRegistry;
 
-	private ValueHolder<JaxbCfgProcessor> jaxbProcessorHolder = new ValueHolder<>(
-			new ValueHolder.DeferredInitializer<JaxbCfgProcessor>() {
+	private final ValueHolder<JaxbCfgProcessor> jaxbProcessorHolder = new ValueHolder<>(
+			new ValueHolder.DeferredInitializer<>() {
 				@Override
 				public JaxbCfgProcessor initialize() {
 					return new JaxbCfgProcessor( bootstrapServiceRegistry.getService( ClassLoaderService.class ) );
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/cfgxml/internal/JaxbCfgProcessor.java b/hibernate-core/src/main/java/org/hibernate/boot/cfgxml/internal/JaxbCfgProcessor.java
@@ -87,14 +87,12 @@ private XMLInputFactory staxFactory() {
 		return staxFactory;
 	}
 
-	@SuppressWarnings( { "UnnecessaryLocalVariable" })
 	private XMLInputFactory buildStaxFactory() {
 		XMLInputFactory staxFactory = XMLInputFactory.newInstance();
 		staxFactory.setXMLResolver( xmlResourceResolver );
 		return staxFactory;
 	}
 
-	@SuppressWarnings( { "unchecked" })
 	private JaxbCfgHibernateConfiguration unmarshal(XMLEventReader staxEventReader, final Origin origin) {
 		XMLEvent event;
 		try {
@@ -165,10 +163,7 @@ private Schema resolveLocalSchema(String schemaName, String schemaLanguage) {
 				SchemaFactory schemaFactory = SchemaFactory.newInstance( schemaLanguage );
 				return schemaFactory.newSchema( source );
 			}
-			catch ( SAXException e ) {
-				throw new XsdException( "Unable to load schema [" + schemaName + "]", e, schemaName );
-			}
-			catch ( IOException e ) {
+			catch ( SAXException | IOException e ) {
 				throw new XsdException( "Unable to load schema [" + schemaName + "]", e, schemaName );
 			}
 			finally {
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/cfgxml/spi/MappingReference.java b/hibernate-core/src/main/java/org/hibernate/boot/cfgxml/spi/MappingReference.java
@@ -19,7 +19,7 @@
  * @author Steve Ebersole
  */
 public class MappingReference {
-	public static enum Type {
+	public enum Type {
 		RESOURCE,
 		CLASS,
 		FILE,
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/internal/BootstrapContextImpl.java b/hibernate-core/src/main/java/org/hibernate/boot/internal/BootstrapContextImpl.java
@@ -45,8 +45,6 @@
 import org.jboss.jandex.IndexView;
 import org.jboss.logging.Logger;
 
-import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
-
 /**
  * @author Andrea Boriero
  */
@@ -78,7 +76,7 @@ public class BootstrapContextImpl implements BootstrapContext {
 	private ArrayList<AuxiliaryDatabaseObject> auxiliaryDatabaseObjectList;
 	private HashMap<Class<?>, ConverterDescriptor> attributeConverterDescriptorMap;
 	private ArrayList<CacheRegionDefinition> cacheRegionDefinitions;
-	private ManagedTypeRepresentationResolver representationStrategySelector;
+	private final ManagedTypeRepresentationResolver representationStrategySelector;
 
 	public BootstrapContextImpl(
 			StandardServiceRegistry serviceRegistry,
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/internal/IdGeneratorInterpreterImpl.java b/hibernate-core/src/main/java/org/hibernate/boot/internal/IdGeneratorInterpreterImpl.java
@@ -105,7 +105,7 @@ public String determineGeneratorName(GenerationType generationType, GeneratorNam
 						return IncrementGenerator.class.getName();
 					}
 
-					final Class javaType = context.getIdType();
+					final Class<?> javaType = context.getIdType();
 					if ( UUID.class.isAssignableFrom( javaType ) ) {
 						return UUIDGenerator.class.getName();
 					}
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/internal/NamedProcedureCallDefinitionImpl.java b/hibernate-core/src/main/java/org/hibernate/boot/internal/NamedProcedureCallDefinitionImpl.java
@@ -43,7 +43,7 @@
 public class NamedProcedureCallDefinitionImpl implements NamedProcedureCallDefinition {
 	private final String registeredName;
 	private final String procedureName;
-	private final Class[] resultClasses;
+	private final Class<?>[] resultClasses;
 	private final String[] resultSetMappings;
 	private final ParameterDefinitions parameterDefinitions;
 	private final Map<String, Object> hints;
@@ -205,7 +205,7 @@ static class ParameterDefinition {
 		private final Integer position;
 		private final String name;
 		private final ParameterMode parameterMode;
-		private final Class type;
+		private final Class<?> type;
 
 		static ParameterDefinition from(
 				ParameterStrategy parameterStrategy,
@@ -234,7 +234,6 @@ private static Boolean interpretBoolean(Object value) {
 			this.type = annotation.type();
 		}
 
-		@SuppressWarnings("UnnecessaryUnboxing")
 		public ParameterMemento toMemento(SessionFactoryImplementor sessionFactory) {
 			// todo (6.0): figure out how to handle this
 //			final boolean initialPassNullSetting = explicitPassNullSetting != null
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/dialect/internal/DialectResolverInitiator.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/dialect/internal/DialectResolverInitiator.java
@@ -23,7 +23,6 @@
  *
  * @author Steve Ebersole
  */
-@SuppressWarnings("deprecation")
 public class DialectResolverInitiator implements StandardServiceInitiator<DialectResolver> {
 	/**
 	 * Singleton access
@@ -55,9 +54,8 @@ private void applyCustomerResolvers(
 		if ( StringHelper.isNotEmpty( resolverImplNames ) ) {
 			for ( String resolverImplName : StringHelper.split( ", \n\r\f\t", resolverImplNames ) ) {
 				try {
-					resolverSet.addResolver(
-							(DialectResolver) classLoaderService.classForName( resolverImplName ).newInstance()
-					);
+					DialectResolver dialectResolver = (DialectResolver) classLoaderService.classForName(resolverImplName).newInstance();
+					resolverSet.addResolver( dialectResolver );
 				}
 				catch (HibernateException e) {
 					throw e;
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/dialect/internal/DialectResolverSet.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/dialect/internal/DialectResolverSet.java
@@ -27,7 +27,7 @@
 public class DialectResolverSet implements DialectResolver {
 	private static final CoreMessageLogger LOG = CoreLogging.messageLogger( DialectResolverSet.class );
 
-	private List<DialectResolver> resolvers;
+	private final List<DialectResolver> resolvers;
 
 	public DialectResolverSet() {
 		this( new ArrayList<>() );
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/dialect/spi/BasicDialectResolver.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/dialect/spi/BasicDialectResolver.java
@@ -21,7 +21,7 @@ public class BasicDialectResolver implements DialectResolver {
 	private final int majorVersionToMatch;
 	private final int minorVersionToMatch;
 
-	private final Class dialectClass;
+	private final Class<?> dialectClass;
 
 	/**
 	 * Constructs a BasicDialectResolver
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/SingletonIterator.java b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/SingletonIterator.java
@@ -12,7 +12,7 @@
  * @author Gavin King
  */
 public final class SingletonIterator<T> implements Iterator<T> {
-	private T value;
+	private final T value;
 	private boolean hasNext = true;
 
 	public boolean hasNext() {
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/StandardStack.java b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/StandardStack.java
@@ -34,14 +34,14 @@ public StandardStack(T initial) {
 
 	@Override
 	public void push(T newCurrent) {
-		Object toStore = newCurrent;
+		T toStore = newCurrent;
 		if ( newCurrent == null ) {
-			toStore = NULL_TOKEN;
+			toStore = (T) NULL_TOKEN;
 		}
 		stackInstanceExpected().addFirst( toStore );
 	}
 
-	private Deque stackInstanceExpected() {
+	private Deque<T> stackInstanceExpected() {
 		if ( internalStack == null ) {
 			//"7" picked to use 8, but skipping the odd initialCapacity method
 			internalStack = new ArrayDeque<>( 7 );
@@ -108,10 +108,9 @@ public <X> X findCurrentFirst(Function<T, X> function) {
 		if ( internalStack == null ) {
 			return null;
 		}
-		final Iterator<T> iterator = internalStack.iterator();
-		while ( iterator.hasNext() ) {
-			final X result = function.apply( iterator.next() );
-			if ( result != null ) {
+		for (T t : internalStack) {
+			final X result = function.apply(t);
+			if (result != null) {
 				return result;
 			}
 		}
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/compare/ComparableComparator.java b/hibernate-core/src/main/java/org/hibernate/internal/util/compare/ComparableComparator.java
@@ -23,7 +23,7 @@ public static <T extends Comparable> Comparator<T> instance() {
 		return INSTANCE;
 	}
 
-	@SuppressWarnings({ "unchecked" })
+	@SuppressWarnings("unchecked")
 	public int compare(Comparable one, Comparable another) {
 		return one.compareTo( another );
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/xml/DTDEntityResolver.java b/hibernate-core/src/main/java/org/hibernate/internal/util/xml/DTDEntityResolver.java
@@ -87,7 +87,7 @@ private InputSource resolveOnClassPath(String publicId, String systemId, String
 		InputStream dtdStream = resolveInHibernateNamespace( path );
 		if ( dtdStream == null ) {
 			LOG.debugf( "Unable to locate [%s] on classpath", systemId );
-			if ( systemId.substring( namespace.length() ).indexOf( "2.0" ) > -1 ) {
+			if ( systemId.substring( namespace.length() ).contains("2.0") ) {
 				LOG.usingOldDtd();
 			}
 		}
diff --git a/hibernate-core/src/main/java/org/hibernate/tool/schema/Action.java b/hibernate-core/src/main/java/org/hibernate/tool/schema/Action.java
@@ -15,7 +15,7 @@
 public enum Action {
 	/**
 	 * No action will be performed.  Valid in JPA; compatible with Hibernate's
-	 * hbm2ddl action of the same name..
+	 * hbm2ddl action of the same name.
 	 */
 	NONE( "none" ),
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/type/spi/TypeConfiguration.java b/hibernate-core/src/main/java/org/hibernate/type/spi/TypeConfiguration.java
@@ -232,7 +232,7 @@ public void addBasicTypeRegistrationContributions(List<BasicTypeRegistration> co
 
 			javaTypeRegistry.resolveDescriptor(
 					basicType.getJavaType(),
-					() -> basicType.getJavaTypeDescriptor()
+					basicType::getJavaTypeDescriptor
 			);
 
 			jdbcToHibernateTypeContributionMap.computeIfAbsent(

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`import org.hibernate.cfg.AvailableSettings;`
`11`	`11`
`12`	`12`	`/**`
`13`		`- * Defines the possible values for "hbm2ddl_auto"`
	`13`	`+ * Defines the possible values for {@value AvailableSettings#HBM2DDL_AUTO}.`
`14`	`14`	`*`
`15`	`15`	`* @author Steve Ebersole`
`16`	`16`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@`
`31`	`31`	`*`
`32`	`32`	`* @since 5.0`
`33`	`33`	`*/`
`34`		`-@SuppressWarnings("UnusedReturnValue")`
`35`	`34`	`public interface SessionFactoryBuilder {`
`36`	`35`	`/**`
`37`	`36`	`* Specifies a Bean Validation {@link jakarta.validation.ValidatorFactory}.`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@ public UnsupportedOrmXsdVersionException(String requestedVersion, Origin origin)`
`19`	`19`	`this.requestedVersion = requestedVersion;`
`20`	`20`	`}`
`21`	`21`
`22`		`- @SuppressWarnings("UnusedDeclaration")`
`23`	`22`	`public String getRequestedVersion() {`
`24`	`23`	`return requestedVersion;`
`25`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -87,14 +87,12 @@ private XMLInputFactory staxFactory() {`
`87`	`87`	`return staxFactory;`
`88`	`88`	`}`
`89`	`89`
`90`		`- @SuppressWarnings( { "UnnecessaryLocalVariable" })`
`91`	`90`	`private XMLInputFactory buildStaxFactory() {`
`92`	`91`	`XMLInputFactory staxFactory = XMLInputFactory.newInstance();`
`93`	`92`	`staxFactory.setXMLResolver( xmlResourceResolver );`
`94`	`93`	`return staxFactory;`
`95`	`94`	`}`
`96`	`95`
`97`		`- @SuppressWarnings( { "unchecked" })`
`98`	`96`	`private JaxbCfgHibernateConfiguration unmarshal(XMLEventReader staxEventReader, final Origin origin) {`
`99`	`97`	`XMLEvent event;`
`100`	`98`	`try {`
`@@ -165,10 +163,7 @@ private Schema resolveLocalSchema(String schemaName, String schemaLanguage) {`
`165`	`163`	`SchemaFactory schemaFactory = SchemaFactory.newInstance( schemaLanguage );`
`166`	`164`	`return schemaFactory.newSchema( source );`
`167`	`165`	`}`
`168`		`- catch ( SAXException e ) {`
`169`		`- throw new XsdException( "Unable to load schema [" + schemaName + "]", e, schemaName );`
`170`		`- }`
`171`		`- catch ( IOException e ) {`
	`166`	`+ catch ( SAXException \| IOException e ) {`
`172`	`167`	`throw new XsdException( "Unable to load schema [" + schemaName + "]", e, schemaName );`
`173`	`168`	`}`
`174`	`169`	`finally {`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ public String determineGeneratorName(GenerationType generationType, GeneratorNam`
`105`	`105`	`return IncrementGenerator.class.getName();`
`106`	`106`	`}`
`107`	`107`
`108`		`- final Class javaType = context.getIdType();`
	`108`	`+ final Class<?> javaType = context.getIdType();`
`109`	`109`	`if ( UUID.class.isAssignableFrom( javaType ) ) {`
`110`	`110`	`return UUIDGenerator.class.getName();`
`111`	`111`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,14 +34,14 @@ public StandardStack(T initial) {`
`34`	`34`
`35`	`35`	`@Override`
`36`	`36`	`public void push(T newCurrent) {`
`37`		`- Object toStore = newCurrent;`
	`37`	`+ T toStore = newCurrent;`
`38`	`38`	`if ( newCurrent == null ) {`
`39`		`- toStore = NULL_TOKEN;`
	`39`	`+ toStore = (T) NULL_TOKEN;`
`40`	`40`	`}`
`41`	`41`	`stackInstanceExpected().addFirst( toStore );`
`42`	`42`	`}`
`43`	`43`
`44`		`- private Deque stackInstanceExpected() {`
	`44`	`+ private Deque<T> stackInstanceExpected() {`
`45`	`45`	`if ( internalStack == null ) {`
`46`	`46`	`//"7" picked to use 8, but skipping the odd initialCapacity method`
`47`	`47`	`internalStack = new ArrayDeque<>( 7 );`
`@@ -108,10 +108,9 @@ public <X> X findCurrentFirst(Function<T, X> function) {`
`108`	`108`	`if ( internalStack == null ) {`
`109`	`109`	`return null;`
`110`	`110`	`}`
`111`		`- final Iterator<T> iterator = internalStack.iterator();`
`112`		`- while ( iterator.hasNext() ) {`
`113`		`- final X result = function.apply( iterator.next() );`
`114`		`- if ( result != null ) {`
	`111`	`+ for (T t : internalStack) {`
	`112`	`+ final X result = function.apply(t);`
	`113`	`+ if (result != null) {`
`115`	`114`	`return result;`
`116`	`115`	`}`
`117`	`116`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public static <T extends Comparable> Comparator<T> instance() {`
`23`	`23`	`return INSTANCE;`
`24`	`24`	`}`
`25`	`25`
`26`		`- @SuppressWarnings({ "unchecked" })`
	`26`	`+ @SuppressWarnings("unchecked")`
`27`	`27`	`public int compare(Comparable one, Comparable another) {`
`28`	`28`	`return one.compareTo( another );`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ private InputSource resolveOnClassPath(String publicId, String systemId, String`
`87`	`87`	`InputStream dtdStream = resolveInHibernateNamespace( path );`
`88`	`88`	`if ( dtdStream == null ) {`
`89`	`89`	`LOG.debugf( "Unable to locate [%s] on classpath", systemId );`
`90`		`- if ( systemId.substring( namespace.length() ).indexOf( "2.0" ) > -1 ) {`
	`90`	`+ if ( systemId.substring( namespace.length() ).contains("2.0") ) {`
`91`	`91`	`LOG.usingOldDtd();`
`92`	`92`	`}`
`93`	`93`	`}`