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

javadoc

This commit is contained in:
Steve Ebersole 2024-05-31 14:54:45 -05:00
parent 52674096be
commit 0294576c8b
18 changed files with 41 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
gradle/javadoc.gradle
View File

@ -14,15 +14,14 @@ tasks.named( "javadoc", Javadoc ) {
inputs.property "currentYear", currentYear
// exclude any generated sources and internal packages
exclude '**/generated-src/**'
exclude '**/generated/source/**'
exclude '**/generated/sources/**'
exclude '**/internal/**'
exclude 'org/hibernate/grammars'
include '**/*.java'
maxMemory = '512m'
configure( options ) {
quiet()
// this is the config needed to use asciidoclet for Javadoc rendering. It relies on a build from John's PR @ https://github.com/asciidoctor/asciidoclet/pull/91
// however, the PR does not work for me in that Javadocs with `@asciidoclet` are not rendered using asciidoc(tor/let). Also tried the preferable `@asciidoc`
// with the same result. Leaving all this config in place however as the outcome is the same as not enabling it.
@ -40,7 +39,7 @@ tasks.named( "javadoc", Javadoc ) {
// The javadoc folder contains cached versions of the respective element-list files to avoid release issues when servers are down
// When upgrading versions of the libraries, don't forget to update the file contents in the repository
linksOffline 'https://docs.oracle.com/en/java/javase/11/docs/api/', "${project.rootDir}/javadoc/javase11"
linksOffline 'https://docs.oracle.com/en/java/javase/17/docs/api/', "${project.rootDir}/javadoc/javase17"
linksOffline 'https://jakarta.ee/specifications/bean-validation/3.0/apidocs/', "${project.rootDir}/javadoc/jakarta-validation-3.0"
linksOffline 'https://jakarta.ee/specifications/cdi/4.0/apidocs/', "${project.rootDir}/javadoc/jakarta-cdi-4.0"
linksOffline 'https://jakarta.ee/specifications/platform/9/apidocs/', "${project.rootDir}/javadoc/jakarta-platform-9"
@ -55,7 +54,7 @@ tasks.named( "javadoc", Javadoc ) {
'settingDefault:f:Default Value:'
)
addStringOption( 'Xdoclint:none', '-quiet' )
addBooleanOption('Xdoclint:none', true)
}
}

1
hibernate-core/src/main/java/org/hibernate/boot/internal/LimitedCollectionClassification.java
View File

@ -10,7 +10,6 @@ package org.hibernate.boot.internal;
* Limited set of {@linkplain org.hibernate.metamodel.CollectionClassification}
* used in mapping a dynamic model.
*
* @see org.hibernate.boot.jaxb.mapping.spi.JaxbCollectionClassificationImpl
* @see org.hibernate.metamodel.CollectionClassification
*
* @author Steve Ebersole

2
hibernate-core/src/main/java/org/hibernate/boot/model/source/internal/hbm/AbstractSingularAttributeSourceEmbeddedImpl.java
View File

@ -21,7 +21,7 @@ import org.hibernate.boot.model.source.spi.ToolingHintContext;
import org.hibernate.tuple.GenerationTiming;
/**
* Common base class for <component/> and <composite-id/> mappings.
* Common base class for {@code <component/>} and {@code <composite-id/>} mappings.
*
* @author Steve Ebersole
*/

5
hibernate-core/src/main/java/org/hibernate/boot/models/categorize/package-info.java
View File

@ -13,9 +13,8 @@
* <p/>
* Happens in 2 steps -<ol>
* <li>
* Create the "source metamodel" ({@linkplain org.hibernate.models.spi.ClassDetails classes},
* {@linkplain org.hibernate.models.spi.AnnotationUsage annotations},
* {@linkplain org.hibernate.boot.jaxb.mapping.spi.JaxbEntityMappingsImpl XML}, etc.)
* Create the "source metamodel" - {@linkplain org.hibernate.models.spi.ClassDetails classes},
* {@linkplain org.hibernate.boot.jaxb.mapping.spi.JaxbEntityMappingsImpl XML}, etc.
* </li>
* <li>
* Process this "source metamodel" and produce the {@linkplain org.hibernate.boot.models.categorize.spi.CategorizedDomainModel categorized model}

17
hibernate-core/src/main/java/org/hibernate/boot/models/package-info.java
View File

@ -6,21 +6,10 @@
*/
/**
* Overall, this module is responsible for taking a
* Overall, this module is responsible for taking
* {@linkplain org.hibernate.boot.model.process.spi.ManagedResources managed-resources} and
* table them into Hibernate's {@linkplain org.hibernate.mapping boot-time model}.
* <p/>
* Works in 2 broad phases -<ol>
* <li>
* First we {@linkplain org.hibernate.boot.models.categorize categorize} the application's domain model,
* as understood through {@linkplain org.hibernate.boot.model.process.spi.ManagedResources},
* and produce a {@linkplain org.hibernate.boot.models.categorize.spi.CategorizedDomainModel}
* </li>
* <li>
* Finally, the categorized metamodel is {@linkplain org.hibernate.boot.models.bind bound}
* into Hibernate's {@linkplain org.hibernate.mapping boot-time model}.
* </li>
* </ol>
* building the {@code hibernate-models} model ({@linkplain org.hibernate.models.spi.ClassDetails}, etc.)
* to ultimately be bound into Hibernate's {@linkplain org.hibernate.mapping boot-time model}.
*
* @author Steve Ebersole
*/

1
hibernate-core/src/main/java/org/hibernate/boot/models/spi/JdbcTypeRegistration.java
View File

@ -12,7 +12,6 @@ import org.hibernate.models.spi.ClassDetails;
* {@linkplain org.hibernate.type.descriptor.jdbc.JdbcType} registration
*
* @see org.hibernate.annotations.JdbcTypeRegistration
* @see org.hibernate.boot.jaxb.mapping.JaxbJdbcTypeRegistration
*
* @author Steve Ebersole
*/

4
hibernate-core/src/main/java/org/hibernate/boot/models/xml/internal/package-info.java
View File

@ -6,9 +6,7 @@
*/
/**
* Support for processing mapping XML files and applying implied
* {@linkplain org.hibernate.models.spi.AnnotationUsage}
* references over the appropriate
* Support for processing mapping XML files and applying annotation references over the appropriate
* {@linkplain org.hibernate.models.spi.ClassDetails classes},
* {@linkplain org.hibernate.models.spi.FieldDetails fields} and
* {@linkplain org.hibernate.models.spi.MethodDetails methods}.

5
hibernate-core/src/main/java/org/hibernate/boot/models/xml/package-info.java
View File

@ -7,9 +7,8 @@
/**
* Support for processing mapping XML files, ultimately creating/updating
* {@linkplain org.hibernate.models.spi.AnnotationUsage annotation} references
* on the model's {@linkplain org.hibernate.models.spi.AnnotationTarget targets}
* based on the XML.<ol>
* {@linkplain org.hibernate.models.spi.ClassDetails}, {@linkplain org.hibernate.models.spi.FieldDetails}
* and annotation references based on the XML.<ol>
* <li>
* First performs some {@linkplain org.hibernate.boot.models.xml.spi.XmlPreProcessor pre-processing}
* which aggregates information across all XML mappings

8
hibernate-core/src/main/java/org/hibernate/cache/internal/BasicCacheKeyImplementation.java vendored
View File

@ -31,10 +31,6 @@ public final class BasicCacheKeyImplementation implements Serializable {
/**
* Being an internal contract the arguments are not being checked.
* @param originalId
* @param disassembledKey this must be the "disassembled" form of an ID
* @param type
* @param entityOrRoleName
*/
@Internal
public BasicCacheKeyImplementation(
@ -47,10 +43,6 @@ public final class BasicCacheKeyImplementation implements Serializable {
/**
* Being an internal contract the arguments are not being checked.
* @param originalId
* @param disassembledKey this must be the "disassembled" form of an ID
* @param type
* @param entityOrRoleName
*/
@Internal
public BasicCacheKeyImplementation(

2
hibernate-core/src/main/java/org/hibernate/internal/util/ReflectHelper.java
View File

@ -559,7 +559,7 @@ public final class ReflectHelper {
/**
* Find the method that can be used as the getter for this property.
*
* @param containerClass The Class<?> which contains the property
* @param containerClass The Class which contains the property
* @param propertyName The name of the property
*
* @return The getter method, or {@code null} if there is none.

4
hibernate-core/src/main/java/org/hibernate/jpa/internal/util/CacheModeHelper.java
View File

@ -12,8 +12,8 @@ import jakarta.persistence.CacheStoreMode;
import org.hibernate.CacheMode;
/**
* Helper to deal with {@link CacheMode} <-> {@link CacheRetrieveMode}/{@link CacheStoreMode}
* conversions.
* Helper to deal with conversions between {@link CacheMode} and {@link CacheRetrieveMode}/{@link CacheStoreMode}
* .
*
* @author Steve Ebersole
*/

2
hibernate-core/src/main/java/org/hibernate/jpa/internal/util/FlushModeTypeHelper.java
View File

@ -17,7 +17,7 @@ import org.hibernate.MappingException;
import org.jboss.logging.Logger;
/**
* Helper to deal with {@link FlushModeType} <-> {@link FlushMode} conversions.
* Helper to deal with conversions between {@link FlushModeType} and {@link FlushMode}.
*
* @author Steve Ebersole
*/

2
hibernate-core/src/main/java/org/hibernate/jpa/internal/util/LockModeTypeHelper.java
View File

@ -12,7 +12,7 @@ import org.hibernate.LockMode;
import org.hibernate.internal.util.LockModeConverter;
/**
* Helper to deal with {@link LockModeType} <-> {@link LockMode} conversions.
* Helper to deal with conversions between {@link LockModeType} and {@link LockMode}.
*
* @author Steve Ebersole
*/

2
hibernate-core/src/main/java/org/hibernate/metamodel/mapping/package-info.java
View File

@ -10,7 +10,7 @@
* of the application's domain model parts (entities, attributes) to
* relational database objects (tables, columns).
*
* @implNote Built on top of the {@link org.hibernate.persister} package.
* @implNote Built on top of the {@code org.hibernate.persister} package.
*
* @implSpec This entire package is considered incubating at the moment
*/

16
hibernate-core/src/main/java/org/hibernate/query/criteria/HibernateCriteriaBuilder.java
View File

@ -2817,7 +2817,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether an array is a subset of another array.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIncludes(Expression, T[])}
* @deprecated Replaced with {@link #arrayIncludes(Expression, Object[])}
*/
@Incubating
@Deprecated(forRemoval = true)
@ -2829,7 +2829,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether an array is a subset of another array.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIncludes(T[], Expression)}
* @deprecated Replaced with {@link #arrayIncludes(Object[], Expression)}
*/
@Incubating
@Deprecated(forRemoval = true)
@ -2853,7 +2853,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether an array is a subset of another array with nullable elements.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIncludesNullable(Expression, T[])}
* @deprecated Replaced with {@link #arrayIncludesNullable(Expression, Object[])}
*/
@Incubating
@Deprecated(forRemoval = true)
@ -2865,7 +2865,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether an array is a subset of another array with nullable elements.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIncludesNullable(T[], Expression)}
* @deprecated Replaced with {@link #arrayIncludesNullable(Object[], Expression)}
*/
@Incubating
@Deprecated(forRemoval = true)
@ -2937,7 +2937,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether one array has any elements common with another array.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIntersects(Expression, T[])}
* @deprecated Replaced with {@link #arrayIntersects(Expression, Object[])}
*/
@Incubating
@Deprecated(forRemoval = true)
@ -2949,7 +2949,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether one array has any elements common with another array.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIntersects(T[], Expression)}
* @deprecated Replaced with {@link #arrayIntersects(Object[], Expression)}
*/
@Incubating
@Deprecated(forRemoval = true)
@ -2973,7 +2973,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether one array has any elements common with another array, supporting {@code null} elements.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIntersectsNullable(Expression, T[])}
* @deprecated Replaced with {@link #arrayIntersectsNullable(Expression, Object[])}
*/
@Incubating
@Deprecated(forRemoval = true)
@ -2985,7 +2985,7 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
* Whether one array has any elements common with another array, supporting {@code null} elements.
*
* @since 6.4
* @deprecated Replaced with {@link #arrayIntersectsNullable(T[], Expression)}
* @deprecated Replaced with {@link #arrayIntersectsNullable(Object[], jakarta.persistence.criteria.Expression)}
*/
@Incubating
@Deprecated(forRemoval = true)

3
hibernate-core/src/main/java/org/hibernate/query/sqm/produce/function/internal/PatternRenderer.java
View File

@ -138,9 +138,8 @@ public class PatternRenderer {
/**
* The rendering code.
*
* @param sqlAppender
* @param sqlAppender Target for appending
* @param args The arguments to inject into the template
* @return The rendered template with replacements
*/
@SuppressWarnings({ "UnusedDeclaration" })
public void render(

4
hibernate-core/src/main/resources/org/hibernate/xsd/mapping/legacy-mapping-4.0.xsd
View File

@ -84,11 +84,9 @@
<xs:complexType name="ToolingHintType" mixed="true">
<xs:annotation>
<xs:documentation><![CDATA[
<meta.../> is used to assign meta-level attributes to a class
Used to assign meta-level attributes to a class
or property. Is currently used by tooling as a placeholder for
values that is not directly related to OR mappings.
Example: <meta attribute="someHintName">the-hint-value</meta>
]]></xs:documentation>
</xs:annotation>
<xs:simpleContent>

20
javadoc/javase11/element-list → javadoc/javase17/element-list
View File

@ -2,10 +2,12 @@ module:java.base
java.io
java.lang
java.lang.annotation
java.lang.constant
java.lang.invoke
java.lang.module
java.lang.ref
java.lang.reflect
java.lang.runtime
java.math
java.net
java.net.spi
@ -18,7 +20,6 @@ java.nio.file
java.nio.file.attribute
java.nio.file.spi
java.security
java.security.acl
java.security.cert
java.security.interfaces
java.security.spec
@ -35,6 +36,7 @@ java.util.concurrent.atomic
java.util.concurrent.locks
java.util.function
java.util.jar
java.util.random
java.util.regex
java.util.spi
java.util.stream
@ -131,6 +133,7 @@ javax.naming
javax.naming.directory
javax.naming.event
javax.naming.ldap
javax.naming.ldap.spi
javax.naming.spi
module:java.net.http
java.net.http
@ -138,7 +141,6 @@ module:java.prefs
java.util.prefs
module:java.rmi
java.rmi
java.rmi.activation
java.rmi.dgc
java.rmi.registry
java.rmi.server
@ -219,12 +221,14 @@ module:jdk.hotspot.agent
module:jdk.httpserver
com.sun.net.httpserver
com.sun.net.httpserver.spi
module:jdk.incubator.foreign
jdk.incubator.foreign
module:jdk.incubator.vector
jdk.incubator.vector
module:jdk.jartool
com.sun.jarsigner
jdk.security.jarsigner
module:jdk.javadoc
com.sun.javadoc
com.sun.tools.javadoc
jdk.javadoc.doclet
module:jdk.jcmd
module:jdk.jconsole
@ -241,6 +245,7 @@ module:jdk.jfr
jdk.jfr
jdk.jfr.consumer
module:jdk.jlink
module:jdk.jpackage
module:jdk.jshell
jdk.jshell
jdk.jshell.execution
@ -260,11 +265,8 @@ module:jdk.naming.rmi
module:jdk.net
jdk.net
jdk.nio
module:jdk.pack
module:jdk.rmic
module:jdk.scripting.nashorn
jdk.nashorn.api.scripting
jdk.nashorn.api.tree
module:jdk.nio.mapmode
jdk.nio.mapmode
module:jdk.sctp
com.sun.nio.sctp
module:jdk.security.auth