Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

more doc cleanups

This commit is contained in:
Gavin 2022-12-29 16:54:03 +01:00 committed by Gavin King
parent f8b50b39d7
commit c3a35821bd
3 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hibernate-core/src/main/java/org/hibernate/boot/beanvalidation/BeanValidationIntegrator.java
View File

@ -24,6 +24,8 @@ import org.hibernate.service.spi.SessionFactoryServiceRegistry;
import org.jboss.logging.Logger; import org.jboss.logging.Logger;
/** /**
* In {@link Integrator} for Bean Validation.
*
* @author Steve Ebersole * @author Steve Ebersole
*/ */
public class BeanValidationIntegrator implements Integrator { public class BeanValidationIntegrator implements Integrator {

6
hibernate-core/src/main/java/org/hibernate/integrator/spi/package-info.java
View File

@ -6,8 +6,10 @@
*/ */
/** /**
* An SPI for extensions which integrate with Hibernate via the * An SPI for extensions which integrate with Hibernate via the {@link org.hibernate.service.Service} mechanism.
* {@link org.hibernate.service.Service} mechanism. * <p>
* Examples {@linkplain org.hibernate.integrator.spi.Integrator integrators} include: Envers, Hibernate Search,
* Hibernate Reactive, and {@linkplain org.hibernate.boot.beanvalidation.BeanValidationIntegrator Bean Validation}.
* *
* @see org.hibernate.integrator.spi.Integrator * @see org.hibernate.integrator.spi.Integrator
*/ */

27
hibernate-core/src/main/java/org/hibernate/jdbc/WorkExecutor.java
View File

@ -11,7 +11,7 @@ import java.sql.SQLException;
/** /**
* A visitor used for executing a discrete piece of work encapsulated in a * A visitor used for executing a discrete piece of work encapsulated in a
* {@link Work} or {@link ReturningWork} instance.. * {@link Work} or {@link ReturningWork} instance.
* *
* @author Gail Badner * @author Gail Badner
*/ */
@ -20,12 +20,12 @@ public class WorkExecutor<T> {
/** /**
* Execute the discrete work encapsulated by a {@link Work} instance * Execute the discrete work encapsulated by a {@link Work} instance
* using the supplied connection. * using the supplied connection.
* <p>
* Because {@link Work} does not return a value when executed via
* {@link Work#execute(Connection)}, this method always returns null.
* *
* Because {@link Work} does not return a value when executed * @param work The {@link ReturningWork} instance encapsulating the
* (via {@link Work#execute(Connection)}, this method * discrete work
* always returns null.
*
* @param work The @link ReturningWork} instance encapsulating the discrete work
* @param connection The connection on which to perform the work. * @param connection The connection on which to perform the work.
* *
* @return null. * @return null.
@ -33,25 +33,26 @@ public class WorkExecutor<T> {
* @throws SQLException Thrown during execution of the underlying JDBC interaction. * @throws SQLException Thrown during execution of the underlying JDBC interaction.
* @throws org.hibernate.HibernateException Generally indicates a wrapped SQLException. * @throws org.hibernate.HibernateException Generally indicates a wrapped SQLException.
*/ */
public <T> T executeWork(Work work, Connection connection) throws SQLException { public T executeWork(Work work, Connection connection) throws SQLException {
work.execute( connection ); work.execute( connection );
return null; return null;
} }
/** /**
* Execute the discrete work encapsulated by a {@link ReturningWork} instance * Execute the discrete work encapsulated by a {@link ReturningWork}
* using the supplied connection, returning the result of * instance using the supplied connection, returning the result of
* {@link ReturningWork#execute(Connection)} * {@link ReturningWork#execute(Connection)}.
* *
* @param work The @link ReturningWork} instance encapsulating the discrete work * @param work The {@link ReturningWork} instance encapsulating the
* discrete work
* @param connection The connection on which to perform the work. * @param connection The connection on which to perform the work.
* *
* @return the valued returned by <code>work.execute(connection)</code>. * @return the valued returned by {@code work.execute(connection)}.
* *
* @throws SQLException Thrown during execution of the underlying JDBC interaction. * @throws SQLException Thrown during execution of the underlying JDBC interaction.
* @throws org.hibernate.HibernateException Generally indicates a wrapped SQLException. * @throws org.hibernate.HibernateException Generally indicates a wrapped SQLException.
*/ */
public <T> T executeReturningWork(ReturningWork<T> work, Connection connection) throws SQLException { public T executeReturningWork(ReturningWork<T> work, Connection connection) throws SQLException {
return work.execute( connection ); return work.execute( connection );
} }
} }