HHH-15241 fix broken references in javadoc
This commit is contained in:
Nathan Xu
Christian Beikov
parent
691ee7bf5d
commit
d998d6fb48
|
|
@ -19,19 +19,19 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
|||
* collection.
|
||||
* <p>
|
||||
* For example:
|
||||
* <pre>{@code
|
||||
* @Entity
|
||||
* @BatchSize(size = 100)
|
||||
* class Product {
|
||||
* ...
|
||||
* }
|
||||
* }</pre>
|
||||
* <pre>
|
||||
* @Entity
|
||||
* @BatchSize(size = 100)
|
||||
* class Product {
|
||||
* ...
|
||||
* }
|
||||
* </pre>
|
||||
* will initialize up to 100 lazy Product entity proxies at a time, but:
|
||||
* <pre>{@code
|
||||
* @OneToMany
|
||||
* @BatchSize(size = 5) /
|
||||
* Set<Product> getProducts() { ... };
|
||||
* }</pre>
|
||||
* <pre>
|
||||
* @OneToMany
|
||||
* @BatchSize(size = 5) /
|
||||
* Set<Product> getProducts() { ... };
|
||||
* </pre>
|
||||
* will initialize up to 5 lazy collections of products at a time.
|
||||
*
|
||||
* @see org.hibernate.cfg.AvailableSettings#DEFAULT_BATCH_FETCH_SIZE
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ import static org.hibernate.mapping.MappingHelper.injectParameters;
|
|||
* to delay instantiation of the actual {@link Type} instance.
|
||||
*
|
||||
* Generally speaking this information would come from annotations
|
||||
* ({@link org.hibernate.annotations.TypeDef}) or XML mappings. An alternative form of
|
||||
* ({@link org.hibernate.annotations.Type}) or XML mappings. An alternative form of
|
||||
* supplying custom types is programmatically via one of:<ul>
|
||||
* <li>{@link org.hibernate.boot.MetadataBuilder#applyBasicType(BasicType)}</li>
|
||||
* <li>{@link org.hibernate.boot.MetadataBuilder#applyBasicType(UserType, String[])}</li>
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.hibernate.boot.model.source.spi;
|
|||
* </li>
|
||||
* </ul>
|
||||
*
|
||||
* @todo Would love to link this in with {@link org.hibernate.engine.jdbc.internal.TypeInfo}
|
||||
* @todo Would love to link this in with {@link org.hibernate.engine.jdbc.spi.TypeInfo}
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -20,18 +20,18 @@ import org.hibernate.service.Service;
|
|||
* strategy is any interface that has multiple, (possibly short) named implementations.
|
||||
* <p/>
|
||||
* StrategySelector manages resolution of particular implementation by (possibly short) name via the
|
||||
* {@link #selectStrategyImplementor} method, which is the main contract here. As indicated in the docs of that
|
||||
* {@link StrategySelector#selectStrategyImplementor} method, which is the main contract here. As indicated in the docs of that
|
||||
* method the given name might be either a short registered name or the implementation FQN. As an example, consider
|
||||
* resolving the {@link org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder} implementation to use. To use the
|
||||
* JDBC-based TransactionCoordinatorBuilder the passed name might be either {@code "jdbc"} or
|
||||
* {@code "org.hibernate.resource.transaction.backend.jdbc.internal.JdbcResourceLocalTransactionCoordinatorBuilderImpl"} (which is the FQN).
|
||||
* <p/>
|
||||
* Strategy implementations can be managed by {@link #registerStrategyImplementor} and
|
||||
* {@link #unRegisterStrategyImplementor}. Originally designed to help the OSGi use case, though no longer used there.
|
||||
* Strategy implementations can be managed by {@link StrategySelector#registerStrategyImplementor} and
|
||||
* {@link StrategySelector#unRegisterStrategyImplementor}. Originally designed to help the OSGi use case, though no longer used there.
|
||||
* <p/>
|
||||
* The service also exposes a general typing API via {@link #resolveStrategy} and {@link #resolveDefaultableStrategy}
|
||||
* The service also exposes a general typing API via {@link StrategySelector#resolveStrategy} and {@link StrategySelector#resolveDefaultableStrategy}
|
||||
* which accept implementation references rather than implementation names, allowing for a multitude of interpretations
|
||||
* of said "implementation reference". See the docs for {@link #resolveDefaultableStrategy} for details.
|
||||
* of said "implementation reference". See the docs for {@link StrategySelector#resolveDefaultableStrategy} for details.
|
||||
*
|
||||
* @author Christian Beikov
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1637,7 +1637,7 @@ public interface AvailableSettings {
|
|||
* Allows passing a specific {@link java.sql.Connection} instance to be used by
|
||||
* {@link org.hibernate.tool.schema.spi.SchemaManagementTool} for the purpose of
|
||||
* determining the {@link org.hibernate.dialect.Dialect}, and for performing
|
||||
* {@value #JAKARTA_HBM2DDL_DATABASE_ACTION database actions} if requested.
|
||||
* {@link #JAKARTA_HBM2DDL_DATABASE_ACTION database actions} if requested.
|
||||
* <p>
|
||||
* For {@code Dialect} resolution, {@value #JAKARTA_HBM2DDL_DB_NAME} and, optionally,
|
||||
* {@value JAKARTA_HBM2DDL_DB_VERSION}, {@value #JAKARTA_HBM2DDL_DB_MAJOR_VERSION},
|
||||
|
|
@ -1663,7 +1663,7 @@ public interface AvailableSettings {
|
|||
* @see #JAKARTA_HBM2DDL_DB_MAJOR_VERSION
|
||||
* @see #JAKARTA_HBM2DDL_DB_MINOR_VERSION
|
||||
*
|
||||
* @implSpec {@value #JAKARTA_HBM2DDL_DATABASE_ACTION database actions} are not
|
||||
* @implSpec {@link #JAKARTA_HBM2DDL_DATABASE_ACTION database actions} are not
|
||||
* available when supplying just the name and versions
|
||||
*/
|
||||
String JAKARTA_HBM2DDL_DB_NAME = "jakarta.persistence.database-product-name";
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ public class SQLServer2005LimitHandler extends AbstractLimitHandler {
|
|||
}
|
||||
|
||||
/**
|
||||
* When the offset of the given {@link RowSelection} is {@literal 0},
|
||||
* When the offset of the current row is {@literal 0},
|
||||
* add a {@code top(?)} clause to the given SQL query. When the offset
|
||||
* is non-zero, wrap the given query in an outer query that limits the
|
||||
* results using the {@code row_number()} window function.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import org.hibernate.graph.spi.RootGraphImplementor;
|
|||
* <p/>
|
||||
* The {@link #parseInto} methods parse the graph string into a passed graph, which may be a sub-graph
|
||||
* <p/>
|
||||
* Multiple graphs made for the same entity type can be merged. See {@link EntityGraphs#merge}.
|
||||
* Multiple graphs made for the same entity type can be merged. See {@link EntityGraphs#merge(SessionImplementor, Class, GraphImplementor...)}.
|
||||
*
|
||||
* @author asusnjar
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -6,12 +6,13 @@
|
|||
*/
|
||||
package org.hibernate.internal.build;
|
||||
|
||||
import java.io.PrintStream;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
|
||||
/**
|
||||
* Used to indicate to the Forbidden APIs library that a specific usage
|
||||
* of {@link Exception#printStackTrace} is allowable.
|
||||
* of {@link Exception#printStackTrace(PrintStream)} is allowable.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ import jakarta.persistence.TemporalType;
|
|||
* {@link jakarta.persistence.Query} and {@link jakarta.persistence.StoredProcedureQuery} implementations. Used to track
|
||||
* information known about the parameter.
|
||||
* <p/>
|
||||
* For parameter information as known to JPA criteria queries, see {@link org.hibernate.query.criteria.internal.expression.ParameterExpressionImpl}
|
||||
* instead.
|
||||
* For parameter information as known to JPA criteria queries,
|
||||
* see {@link org.hibernate.query.sqm.tree.expression.JpaCriteriaParameter} instead.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -8,8 +8,7 @@ package org.hibernate.jpa.spi;
|
|||
|
||||
/**
|
||||
* ParameterRegistration extension specifically for stored procedure parameters
|
||||
* exposing some functionality of Hibernate's native
|
||||
* {@link org.hibernate.procedure.ParameterRegistration} contract
|
||||
* exposing some functionality of Hibernate's native {@link ParameterRegistration} contract
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
@ -19,18 +18,15 @@ public interface StoredProcedureQueryParameterRegistration<T> extends ParameterR
|
|||
*
|
||||
* @return {@code true} here indicates that NULL should be passed; {@code false} indicates
|
||||
* that it is ignored.
|
||||
*
|
||||
* @see ParameterRegistrationImplementor#isPassNullsEnabled()
|
||||
*/
|
||||
boolean isPassNullsEnabled();
|
||||
|
||||
/**
|
||||
* Controls how unbound values for this IN/INOUT parameter registration will be handled prior to
|
||||
* execution. For details see {@link org.hibernate.procedure.ParameterRegistration#enablePassingNulls}
|
||||
* execution.
|
||||
*
|
||||
* @param enabled {@code true} indicates that the NULL should be passed; {@code false} indicates it should not.
|
||||
*
|
||||
* @see org.hibernate.procedure.ParameterRegistration#enablePassingNulls
|
||||
*/
|
||||
void enablePassingNulls(boolean enabled);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ import org.hibernate.metamodel.mapping.PluralAttributeMapping;
|
|||
import org.hibernate.metamodel.mapping.Restrictable;
|
||||
import org.hibernate.metamodel.model.convert.spi.BasicValueConverter;
|
||||
import org.hibernate.metamodel.model.domain.NavigableRole;
|
||||
import org.hibernate.metamodel.spi.RuntimeModelCreationContext;
|
||||
import org.hibernate.persister.entity.EntityPersister;
|
||||
import org.hibernate.sql.ast.spi.SqlAstCreationState;
|
||||
import org.hibernate.sql.ast.tree.from.TableGroup;
|
||||
|
|
@ -62,7 +63,7 @@ import org.hibernate.type.Type;
|
|||
* load and update collection elements.
|
||||
* <p>
|
||||
* Unless a custom {@link org.hibernate.persister.spi.PersisterFactory} is
|
||||
* used, it is expected that implementations of {@link CollectionDefinition}
|
||||
* used, it is expected that implementations of {@link CollectionPersister}
|
||||
* define a constructor accepting the following arguments:
|
||||
* <ol>
|
||||
* <li>
|
||||
|
|
@ -74,9 +75,8 @@ import org.hibernate.type.Type;
|
|||
* for this collection, and
|
||||
* </li>
|
||||
* <li>
|
||||
* {@link org.hibernate.persister.spi.PersisterCreationContext} -
|
||||
* access to additional information useful while constructing the
|
||||
* persister.
|
||||
* {@link RuntimeModelCreationContext} - access to additional
|
||||
* information useful while constructing the persister.
|
||||
* </li>
|
||||
* </ol>
|
||||
*
|
||||
|
|
|
|||
|
|
@ -7,20 +7,19 @@
|
|||
package org.hibernate.persister.entity;
|
||||
|
||||
import org.hibernate.QueryException;
|
||||
import org.hibernate.persister.collection.CompositeElementPropertyMapping;
|
||||
import org.hibernate.type.Type;
|
||||
|
||||
/**
|
||||
* Contract for all things that know how to map a property to the needed bits of SQL.
|
||||
* <p/>
|
||||
* The column/formula fragments that represent a property in the table defining the property be obtained by
|
||||
* calling either {@link #toColumns(String, String)} or {@link #toColumns(String)} to obtain SQL-aliased
|
||||
* column/formula fragments aliased or un-aliased, respectively.
|
||||
*
|
||||
* calling {@link #toColumns(String)}.
|
||||
*
|
||||
* <p/>
|
||||
* Note, the methods here are generally ascribed to accept "property paths". That is a historical necessity because
|
||||
* of how Hibernate originally understood composites (embeddables) internally. That is in the process of changing
|
||||
* as Hibernate has added {@link org.hibernate.loader.plan.build.internal.spaces.CompositePropertyMapping}
|
||||
* as Hibernate has added {@link CompositeElementPropertyMapping}
|
||||
*
|
||||
* todo (6.0) : move to {@link org.hibernate.persister.spi} - that is its more logical home. AFAIK this
|
||||
* has never been documented as a public API
|
||||
|
|
|
|||
|
|
@ -7,8 +7,7 @@
|
|||
|
||||
/**
|
||||
* Package for "walking" associations through metadata definition. Ultimately
|
||||
* want {@link org.hibernate.persister.walking.spi.AttributeDefinition} and
|
||||
* {@link org.hibernate.persister.walking.spi.AttributeSource} etc to become
|
||||
* want {@link org.hibernate.persister.walking.spi.AttributeSource}to become
|
||||
* part of the persister model.
|
||||
*/
|
||||
package org.hibernate.persister.walking.spi;
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ public interface ProcedureOutputs extends Outputs {
|
|||
* Retrieve the value of an OUTPUT parameter by the parameter's registration memento.
|
||||
* <p/>
|
||||
* Should NOT be called for parameters registered as REF_CURSOR. REF_CURSOR parameters should be
|
||||
* accessed via the returns (see {@link #getNextOutput}
|
||||
* accessed via the returns (see {@link #goToNext()}
|
||||
*
|
||||
* @param parameter The parameter's registration memento.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -9,31 +9,31 @@ package org.hibernate.procedure;
|
|||
/**
|
||||
* Defines support for executing database stored procedures and functions and accessing its outputs.
|
||||
* <p/>
|
||||
* First a reference to {@link ProcedureCall} is obtained through one of the overloaded
|
||||
* First a reference to {@link org.hibernate.procedure.ProcedureCall} is obtained through one of the overloaded
|
||||
* {@link org.hibernate.Session#createStoredProcedureCall} methods. The ProcedureCall reference is then used to "configure"
|
||||
* the procedure call (set timeouts, etc) and to perform parameter registration. All procedure parameters that the
|
||||
* application wants to use must be registered. For all IN and INOUT parameters, values can then be bound.
|
||||
* <p/>
|
||||
* At this point we are ready to execute the procedure call and start accessing the outputs. This is done by first
|
||||
* calling the {@link ProcedureCall#getResult()} method. The underlying JDBC call is executed as needed. The pattern to
|
||||
* access the returns is iterating through the outputs while {@link ProcedureResult#hasMoreReturns()} returns {@code true} and
|
||||
* calling {@link ProcedureResult#getNextReturn()} during iteration:
|
||||
* calling the {@link org.hibernate.procedure.ProcedureCall#getOutputs()}} method. The underlying JDBC call is executed as needed. The pattern to
|
||||
* access the returns is iterating through the outputs while {@link org.hibernate.procedure.ProcedureOutputs#goToNext()}} returns {@code true} and
|
||||
* calling {@link org.hibernate.procedure.ProcedureOutputs#getCurrent()}} during iteration:
|
||||
* <code>
|
||||
* ProcedureCall call = session.createStoredProcedureCall( "some_procedure" );
|
||||
* ...
|
||||
* ProcedureResult result = call.getResult();
|
||||
* while ( result.hasMoreReturns() ) {
|
||||
* final Return rtn = result.getNextReturn();
|
||||
* if ( rtn.isResultSet() ) {
|
||||
* handleResultSetReturn( (ResultSetReturn) rtn );
|
||||
* ProcedureOutputs outputs = call.getOutputs();
|
||||
* while ( outputs.goToNext() ) {
|
||||
* final Output output = outputs.getCurrent();
|
||||
* if ( output.isResultSet() ) {
|
||||
* handleResultSetOutput( (ResultSetOutput) output );
|
||||
* }
|
||||
* else {
|
||||
* handleUpdateCountReturn( (UpdateCountReturn) rtn );
|
||||
* handleUpdateCountOutput( (UpdateCountOutput) output );
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
* <p/>
|
||||
* Finally output parameters can be accessed using the overloaded {@link ProcedureResult#getOutputParameterValue} methods.
|
||||
* Finally output parameters can be accessed using the overloaded {@link org.hibernate.procedure.ProcedureOutputs#getOutputParameterValue} methods.
|
||||
* For portability amongst databases, it is advised to access the output parameters after all returns have been
|
||||
* processed.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -16,8 +16,7 @@ import org.hibernate.type.Type;
|
|||
|
||||
/**
|
||||
* Represents a "parameter list" binding: aka the binding of a collection of values for a single
|
||||
* query parameter. At some point these need to be "expanded"; see {@link QueryParameterBindingsImpl#expandListValuedParameters(String)}
|
||||
* for details.
|
||||
* query parameter.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,14 +27,8 @@
|
|||
*
|
||||
* == From Criteria
|
||||
*
|
||||
* Because criteria queries are already typed, `SemanticQueryProducer` offers 3 distinct methods for transforming
|
||||
* select, update and delete criteria trees. Mainly this is done to take advantage of the distinct typing to
|
||||
* define better return types. See
|
||||
*
|
||||
* * {@link org.hibernate.query.criteria.sqm.CriteriaQueryToSqmTransformer#transform}:: For select criteria
|
||||
* transformation
|
||||
* * _update and delete criteria transformations not yet implemented_
|
||||
*
|
||||
* `SemanticQueryProducer` builds SQM directly.
|
||||
* See {@link org.hibernate.query.sqm.internal.SqmCriteriaNodeBuilder} for details
|
||||
*
|
||||
*
|
||||
* == Exceptions
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ import org.hibernate.query.sqm.tree.SqmCopyContext;
|
|||
/**
|
||||
* {@link JpaParameterExpression} created via JPA {@link jakarta.persistence.criteria.CriteriaBuilder}.
|
||||
*
|
||||
* Each occurence of a JpaParameterExpression results in a unique SqmParameter
|
||||
* Each occurrence of a JpaParameterExpression results in a unique SqmParameter
|
||||
*
|
||||
* @see ParameterMetadata
|
||||
* @see NodeBuilder#parameter
|
||||
|
|
|
|||
|
|
@ -10,20 +10,20 @@ package org.hibernate.result;
|
|||
* Defines support for dealing with database results, accounting for mixed result sets and update counts hiding the
|
||||
* complexity (IMO) of how this is exposed in the JDBC API.
|
||||
*
|
||||
* {@link Result} represents the overall group of results.
|
||||
* {@link org.hibernate.result.Outputs} represents the overall group of results.
|
||||
*
|
||||
* {@link Return} represents the mixed individual outcomes, which might be either a {@link ResultSetReturn} or
|
||||
* a {@link UpdateCountReturn}.
|
||||
* {@link org.hibernate.result.Output} represents the mixed individual outcomes, which might be either a {@link org.hibernate.result.ResultSetOutput} or
|
||||
* a {@link org.hibernate.result.UpdateCountOutput}.
|
||||
*
|
||||
* <code>
|
||||
* Result result = ...;
|
||||
* while ( result.hasMoreReturns() ) {
|
||||
* final Return rtn = result.getNextReturn();
|
||||
* Outputs outputs = ...;
|
||||
* while ( outputs.goToNext() ) {
|
||||
* final Output output = outputs.getCurrent();
|
||||
* if ( rtn.isResultSet() ) {
|
||||
* handleResultSetReturn( (ResultSetReturn) rtn );
|
||||
* handleResultSetOutput( (ResultSetOutput) output );
|
||||
* }
|
||||
* else {
|
||||
* handleUpdateCountReturn( (UpdateCountReturn) rtn );
|
||||
* handleUpdateCountOutput( (UpdateCountOutput) output );
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@
|
|||
*/
|
||||
package org.hibernate.service.spi;
|
||||
|
||||
import org.hibernate.service.UnknownUnwrapTypeException;
|
||||
|
||||
/**
|
||||
* Optional contract for services that wrap stuff that to which it is useful to have access. For example, a service
|
||||
* that maintains a {@link javax.sql.DataSource} might want to expose access to the {@link javax.sql.DataSource} or
|
||||
|
|
|
|||
|
|
@ -24,8 +24,6 @@ import org.hibernate.type.descriptor.ValueExtractor;
|
|||
* {@link #getValuesArrayPosition}:: The position for this selection in relation to the "JDBC values array" (see {@link RowProcessingState#getJdbcValue})
|
||||
* {@link #getJdbcResultSetIndex()}:: The position for this selection in relation to the JDBC object (ResultSet, etc)
|
||||
*
|
||||
* Additional support for allowing a selection to "prepare" itself prior to first use is defined through
|
||||
* {@link #prepare}. This is generally only used for NativeQuery execution.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -73,10 +73,10 @@ public class QueryStatisticsImpl implements QueryStatistics {
|
|||
|
||||
/**
|
||||
* Number of lines returned by all the executions of this query (from DB)
|
||||
* For now, {@link Query#iterate()}
|
||||
* For now, {@link Query#stream()}}
|
||||
* and {@link Query#scroll()} do not fill this statistic
|
||||
*
|
||||
* @return The number of rows cumulatively returned by the given query; iterate
|
||||
* @return The number of rows cumulatively returned by the given query; stream
|
||||
* and scroll queries do not effect this total as their number of returned rows
|
||||
* is not known at execution time.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -112,8 +112,7 @@ public interface Type extends Serializable {
|
|||
int[] getSqlTypeCodes(Mapping mapping) throws MappingException;
|
||||
|
||||
/**
|
||||
* The class returned by {@link #nullSafeGet} methods. This is used to establish the class of an array of
|
||||
* this type.
|
||||
* The class handled by this type.
|
||||
*
|
||||
* @return The java type class handled by this type.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue