HHH-15785 Fix javadoc errors
This commit is contained in:
Marco Belladelli
Christian Beikov
parent
56eb241dec
commit
be9358e02f
|
|
@ -61,6 +61,7 @@ package org.hibernate.community.dialect;
|
|||
* "name=value" pairs:
|
||||
* <p>
|
||||
* <table border="">
|
||||
* <caption>Properties</caption>
|
||||
* <tr>
|
||||
* <th>Property Name</th>
|
||||
* <th>Property Value</th>
|
||||
|
|
|
|||
|
|
@ -610,7 +610,7 @@ public class PostgreSQLLegacyDialect extends Dialect {
|
|||
* stype = uuid,
|
||||
* combinefunc = min,
|
||||
* parallel = safe,
|
||||
* sortop = operator (<)
|
||||
* sortop = operator (<)
|
||||
* );
|
||||
*
|
||||
* create or replace function max(uuid, uuid)
|
||||
|
|
@ -628,7 +628,7 @@ public class PostgreSQLLegacyDialect extends Dialect {
|
|||
* stype = uuid,
|
||||
* combinefunc = max,
|
||||
* parallel = safe,
|
||||
* sortop = operator (>)
|
||||
* sortop = operator (>)
|
||||
* );
|
||||
* </code>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
/**
|
||||
* A set of mapping annotations which extend the O/R mapping annotations defined by JPA.
|
||||
*
|
||||
* <h3 id="basic-value-mapping">Basic value mapping</h3>
|
||||
* <h2 id="basic-value-mapping">Basic value mapping</h2>
|
||||
*
|
||||
* Hibernate supports 2 approaches to defining a mapping strategy for basic values:<ul>
|
||||
* <li>
|
||||
|
|
|
|||
|
|
@ -413,7 +413,7 @@ public class MetadataSources implements Serializable {
|
|||
* the DOM structure of a particular mapping. It is saved from a previous call
|
||||
* as a file with the name {@code {xmlFile}.bin} where {@code {xmlFile}} is the
|
||||
* name of the original mapping file.
|
||||
* </p>
|
||||
* <p>
|
||||
* If a cached {@code {xmlFile}.bin} exists and is newer than {@code {xmlFile}},
|
||||
* the {@code {xmlFile}.bin} file will be read directly. Otherwise {@code {xmlFile}}
|
||||
* is read and then serialized to {@code {xmlFile}.bin} for use the next time.
|
||||
|
|
@ -431,7 +431,7 @@ public class MetadataSources implements Serializable {
|
|||
* the DOM structure of a particular mapping. It is saved from a previous call
|
||||
* as a file with the name {@code {xmlFile}.bin} where {@code {xmlFile}} is the
|
||||
* name of the original mapping file.
|
||||
* </p>
|
||||
* <p>
|
||||
* If a cached {@code {xmlFile}.bin} exists and is newer than {@code {xmlFile}},
|
||||
* the {@code {xmlFile}.bin} file will be read directly. Otherwise {@code {xmlFile}}
|
||||
* is read and then serialized to {@code {xmlFile}.bin} for use the next time.
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ public class HbmResultSetMappingDescriptor implements NamedResultSetMappingDescr
|
|||
|
||||
|
||||
/**
|
||||
* Constructor for an explicit `<resultset/>` mapping.
|
||||
* Constructor for an explicit {@code <resultset/>} mapping.
|
||||
*/
|
||||
public HbmResultSetMappingDescriptor(
|
||||
JaxbHbmResultSetMappingType hbmResultSetMapping,
|
||||
|
|
|
|||
|
|
@ -48,6 +48,7 @@ import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
|
|||
* <li>any instance of {@link Properties} passed to {@link Configuration#addProperties}.
|
||||
* </ul>
|
||||
* <table>
|
||||
* <caption>Configuration properties</caption>
|
||||
* <tr><td><b>Property</b></td><td><b>Interpretation</b></td></tr>
|
||||
* <tr>
|
||||
* <td>{@value #DIALECT}</td>
|
||||
|
|
@ -74,6 +75,7 @@ import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
|
|||
* {@link java.sql.DriverManager})
|
||||
* </td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@value #POOL_SIZE}</td>
|
||||
* <td>the maximum size of the connection pool (only when using
|
||||
* {@link java.sql.DriverManager})
|
||||
|
|
|
|||
|
|
@ -4418,7 +4418,7 @@ public abstract class Dialect implements ConversionContext {
|
|||
|
||||
/**
|
||||
* The SchemaManagementTool to use if none explicitly specified.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Allows Dialects to override how schema tooling works by default
|
||||
*/
|
||||
@Incubating
|
||||
|
|
|
|||
|
|
@ -596,7 +596,7 @@ public class PostgreSQLDialect extends Dialect {
|
|||
* stype = uuid,
|
||||
* combinefunc = min,
|
||||
* parallel = safe,
|
||||
* sortop = operator (<)
|
||||
* sortop = operator (<)
|
||||
* );
|
||||
*
|
||||
* create or replace function max(uuid, uuid)
|
||||
|
|
@ -614,7 +614,7 @@ public class PostgreSQLDialect extends Dialect {
|
|||
* stype = uuid,
|
||||
* combinefunc = max,
|
||||
* parallel = safe,
|
||||
* sortop = operator (>)
|
||||
* sortop = operator (>)
|
||||
* );
|
||||
* </code>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ import org.hibernate.engine.jdbc.mutation.group.PreparedStatementGroup;
|
|||
|
||||
/**
|
||||
* Conceptually models a batch.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Unlike in JDBC, here we add the ability to batch together multiple statements at a time. In the underlying
|
||||
* JDBC this correlates to multiple {@link PreparedStatement} objects (one for each DML string) maintained within the
|
||||
* batch.
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ public interface PreparedStatementDetails {
|
|||
|
||||
/**
|
||||
* The {@link PreparedStatement} generated from the SQL.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Unlike {@link #getStatement()}, this method will attempt to create the PreparedStatement
|
||||
*/
|
||||
PreparedStatement resolveStatement();
|
||||
|
|
|
|||
|
|
@ -45,8 +45,8 @@ import static org.hibernate.internal.util.NullnessHelper.coalesceSuppliedValues;
|
|||
* a sequence. These variations are encapsulated by the {@link DatabaseStructure}
|
||||
* interface internally.
|
||||
* <p>
|
||||
* General configuration parameters:
|
||||
* <table>
|
||||
* <caption>General configuration parameters</caption>
|
||||
* <tr>
|
||||
* <td><b>NAME</b></td>
|
||||
* <td><b>DEFAULT</b></td>
|
||||
|
|
@ -81,6 +81,7 @@ import static org.hibernate.internal.util.NullnessHelper.coalesceSuppliedValues;
|
|||
* <p>
|
||||
* Configuration parameters used specifically when the underlying structure is a table:
|
||||
* <table>
|
||||
* <caption>Table configuration parameters</caption>
|
||||
* <tr>
|
||||
* <td><b>NAME</b></td>
|
||||
* <td><b>DEFAULT</b></td>
|
||||
|
|
|
|||
|
|
@ -74,8 +74,8 @@ import static org.hibernate.internal.util.NullnessHelper.coalesceSuppliedValues;
|
|||
* {@link #CONFIG_PREFER_SEGMENT_PER_ENTITY} can be used to change that to
|
||||
* instead default to using a row for each entity name.
|
||||
* <p>
|
||||
* Configuration parameters:
|
||||
* <table>
|
||||
* <caption>Configuration parameters</caption>
|
||||
* <tr>
|
||||
* <td><b>NAME</b></td>
|
||||
* <td><b>DEFAULT</b></td>
|
||||
|
|
|
|||
|
|
@ -27,10 +27,10 @@ public interface SelectableConsumer {
|
|||
/**
|
||||
* Simple form of visitation over a number of columns by name, using
|
||||
* a separate {@link SelectableMappings} as a base for additional details.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Intended for use in visiting table keys, where we know JdbcMappings, etc.
|
||||
* from the identifier.
|
||||
* <p/>
|
||||
* <p>
|
||||
* The expectation here is for the following details to be available:<ul>
|
||||
* <li>{@link SelectableMapping#getContainingTableExpression()}</li>
|
||||
* <li>{@link SelectableMapping#getSelectionExpression()} (the column name)</li>
|
||||
|
|
|
|||
|
|
@ -61,12 +61,12 @@ public interface EntityCollectionPart extends CollectionPart, EntityValuedFetcha
|
|||
|
||||
/**
|
||||
* Perform any delayed initialization.
|
||||
* <p/>
|
||||
* <p>
|
||||
* The initialization is considered successful if the result is {@code true}. It is
|
||||
* considered unsuccessful if the result is {@code false} or an exception is thrown.
|
||||
* Unsuccessful initializations are generally retried "later", to allow waiting for
|
||||
* model-parts being available e.g.
|
||||
* <p/>
|
||||
* <p>
|
||||
* If the exception is something that will just never succeed, consider throwing
|
||||
* an exception with the {@link NonTransientException} marker to allow the creation
|
||||
* process to stop immediately
|
||||
|
|
|
|||
|
|
@ -13,10 +13,10 @@ import org.hibernate.persister.collection.CollectionPersister;
|
|||
|
||||
/**
|
||||
* Coordinates the logical insertion of collection entries which are not yet persistent.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Insertions are determined by {@linkplain EntryFilter filtering} the entries obtained
|
||||
* from {@link PersistentCollection#entries(CollectionPersister)}.
|
||||
* <p/>
|
||||
* <p>
|
||||
* A "logical" insertion because the actual SQL used may be an UPDATE in the case of
|
||||
* one-to-many mappings to set the foreign-key
|
||||
*
|
||||
|
|
|
|||
|
|
@ -6054,7 +6054,7 @@ public abstract class AbstractEntityPersister
|
|||
|
||||
/**
|
||||
* Decide which tables need to be updated.
|
||||
* <p/>
|
||||
* <p>
|
||||
* The return here is an array of boolean values with each index corresponding
|
||||
* to a given table in the scope of this persister.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -396,8 +396,8 @@ public interface EntityPersister
|
|||
* Determine whether optimistic locking by column is enabled for this
|
||||
* entity.
|
||||
*
|
||||
* @return True if optimistic locking by column (i.e., <version/> or
|
||||
* <timestamp/>) is enabled; false otherwise.
|
||||
* @return True if optimistic locking by column (i.e., {@code <version/>} or
|
||||
* {@code <timestamp/>}) is enabled; false otherwise.
|
||||
*/
|
||||
boolean isVersioned();
|
||||
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ public interface Queryable extends Loadable, PropertyMapping, Joinable {
|
|||
/**
|
||||
* The alias used for any filter conditions (mapped where-fragments or
|
||||
* enabled-filters).
|
||||
* </p>
|
||||
* <p>
|
||||
* This may or may not be different from the root alias depending upon the
|
||||
* inheritance mapping strategy.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ public interface EntityMutationTarget extends MutationTarget<EntityTableMapping>
|
|||
|
||||
/**
|
||||
* Whether this target defines any potentially skippable tables.
|
||||
* </p>
|
||||
* <p>
|
||||
* A table is considered potentially skippable if it is defined
|
||||
* as inverse or as optional.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
/**
|
||||
* Support for immutable result/fetch builder graph nodes built from static sources
|
||||
* such as JPA's {@link jakarta.persistence.SqlResultSetMapping} or `hbm.xml` mapping
|
||||
* `<resultset/>`.
|
||||
* {@code <resultset/>}.
|
||||
*
|
||||
* The differentiation from {@link org.hibernate.query.results.dynamic} is that here
|
||||
* we have up-front knowledge of the complete mapping graph and can perform optimized
|
||||
|
|
|
|||
|
|
@ -7361,7 +7361,7 @@ public abstract class AbstractSqlAstTranslator<T extends JdbcOperation> implemen
|
|||
* and <code>≥</code> operators.
|
||||
* <p>
|
||||
* Basically, does it support syntax like
|
||||
* "... where (FIRST_NAME, LAST_NAME) < ('Steve', 'Ebersole') ...".
|
||||
* "... where (FIRST_NAME, LAST_NAME) < ('Steve', 'Ebersole') ...".
|
||||
*
|
||||
* @return True if this SQL dialect is known to support "row value
|
||||
* constructor" syntax with relational comparison operators; false otherwise.
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.hibernate.sql.model.jdbc.JdbcValueDescriptor;
|
|||
* example #3 - insert simple entity (Person)
|
||||
* (1) MutationOperation(INSERT, person)
|
||||
*
|
||||
* example #4 - insert entity (Person) w/ secondary *non-optional* table & IDENTITY id column
|
||||
* example #4 - insert entity (Person) w/ secondary *non-optional* table & IDENTITY id column
|
||||
* (1) MutationOperation(INSERT, person)
|
||||
* (2) MutationOperation(INSERT, person_supp)
|
||||
*
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@ import org.hibernate.sql.model.ValuesAnalysis;
|
|||
/**
|
||||
* Describes the mutation of a model table (mapped by an entity or collection)
|
||||
* triggered from flush.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Modeled as a SQL AST and processed via {@link org.hibernate.sql.ast.SqlAstTranslator}
|
||||
* <p/>
|
||||
* <p>
|
||||
* Acts as a factory for {@link org.hibernate.sql.model.MutationOperation} instances,
|
||||
* which are the forms used to "perform" the mutation using JDBC.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -15,20 +15,19 @@ import org.hibernate.property.access.spi.Getter;
|
|||
* a particular representation of a piece of data, given that
|
||||
* representation's {@link RepresentationMode} (the entity-mode
|
||||
* essentially defining which representation).
|
||||
* </p>
|
||||
* <p>
|
||||
* If that given piece of data is thought of as a data structure, then a tuplizer
|
||||
* is the thing which knows how to<ul>
|
||||
* <li>create such a data structure appropriately
|
||||
* <li>extract values from and inject values into such a data structure
|
||||
* </ul>
|
||||
* </p>
|
||||
* <p>
|
||||
* For example, a given piece of data might be represented as a POJO class.
|
||||
* Here, it's representation and entity-mode is POJO. Well a tuplizer for POJO
|
||||
* entity-modes would know how to<ul>
|
||||
* <li>create the data structure by calling the POJO's constructor
|
||||
* <li>extract and inject values through getters/setter, or by direct field access, etc
|
||||
* </ul>
|
||||
* </p>
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*
|
||||
|
|
@ -48,10 +47,10 @@ public interface Tuplizer {
|
|||
|
||||
/**
|
||||
* Return the pojo class managed by this tuplizer.
|
||||
* </p>
|
||||
* <p>
|
||||
* Need to determine how to best handle this for the Tuplizers for EntityModes
|
||||
* other than POJO.
|
||||
* </p>
|
||||
* <p>
|
||||
* todo : be really nice to not have this here since it is essentially pojo specific...
|
||||
*
|
||||
* @return The persistent class.
|
||||
|
|
|
|||
|
|
@ -172,7 +172,7 @@ public enum SpatialFunction {
|
|||
/**
|
||||
* The filter function
|
||||
* <p>
|
||||
* <p>Corresponds to the Oracle Spatial's "SDO_FILTER" function, or the "&&" operator of PostGIS.
|
||||
* <p>Corresponds to the Oracle Spatial's "SDO_FILTER" function, or the "&&" operator of PostGIS.
|
||||
*/
|
||||
filter( "filter" ),
|
||||
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ public interface SpatialRelation {
|
|||
/**
|
||||
* The bounding box of the first geometry intersects the bounding box of the second
|
||||
* <p>
|
||||
* <p>This relation is not defined in OGC 99-049, it corresponds to the Postgis '&&' operator.</p>
|
||||
* <p>This relation is not defined in OGC 99-049, it corresponds to the Postgis '&&' operator.</p>
|
||||
*/
|
||||
public static int FILTER = 8;
|
||||
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ public class SchemaExportTask extends MatchingTask {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set a <literal>.cfg.xml</literal> file, which will be
|
||||
* Set a {@code .cfg.xml} file, which will be
|
||||
* loaded as a resource, from the classpath
|
||||
* @param configurationFile the path to the resource
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ public class SchemaValidatorTask extends MatchingTask {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set a <literal>.cfg.xml</literal> file
|
||||
* Set a {@code .cfg.xml} file
|
||||
* @param configurationFile the file name
|
||||
*/
|
||||
public void setConfig(File configurationFile) {
|
||||
|
|
|
|||
Loading…
Reference in New Issue