misc Javadoc fixes, and added @links
This commit is contained in:
Gavin King
Steve Ebersole
parent
8adc1d8d70
commit
92a000b8e6
|
|
@ -36,14 +36,14 @@ public enum FetchMode {
|
|||
/**
|
||||
* Fetch lazily. Equivalent to {@code outer-join="false"}.
|
||||
*
|
||||
* @deprecated use {@code FetchMode.SELECT}
|
||||
* @deprecated use {@link #SELECT}
|
||||
*/
|
||||
@Deprecated
|
||||
public static final FetchMode LAZY = SELECT;
|
||||
/**
|
||||
* Fetch eagerly, using an outer join. Equivalent to {@code outer-join="true"}.
|
||||
*
|
||||
* @deprecated use {@code FetchMode.JOIN}
|
||||
* @deprecated use {@link #JOIN}
|
||||
*/
|
||||
@Deprecated
|
||||
public static final FetchMode EAGER = JOIN;
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ import org.hibernate.proxy.LazyInitializer;
|
|||
* <ul>
|
||||
* <li>Provides access to the full range of Hibernate built-in types. {@code Type}
|
||||
* instances may be used to bind values to query parameters.
|
||||
* <li>A factory for new {@code Blob}s and {@code Clob}s.
|
||||
* <li>A factory for new {@link java.sql.Blob}s and {@link java.sql.Clob}s.
|
||||
* <li>Defines static methods for manipulation of proxies.
|
||||
* </ul>
|
||||
*
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ package org.hibernate;
|
|||
public enum LockMode {
|
||||
/**
|
||||
* No lock required. If an object is requested with this lock
|
||||
* mode, a {@code READ} lock will be obtained if it is
|
||||
* mode, a {@link #READ} lock will be obtained if it is
|
||||
* necessary to actually read the state from the database,
|
||||
* rather than pull it from a cache.
|
||||
* <p>
|
||||
|
|
@ -46,7 +46,7 @@ public enum LockMode {
|
|||
* Attempt to obtain an upgrade lock, using an Oracle-style
|
||||
* {@code select for update nowait}. The semantics of
|
||||
* this lock mode, once obtained, are the same as
|
||||
* {@code UPGRADE}.
|
||||
* {@link #UPGRADE}.
|
||||
*/
|
||||
UPGRADE_NOWAIT( 10, "upgrade-nowait" ),
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ public enum LockMode {
|
|||
* Attempt to obtain an upgrade lock, using an Oracle-style
|
||||
* {@code select for update skip locked}. The semantics of
|
||||
* this lock mode, once obtained, are the same as
|
||||
* {@code UPGRADE}.
|
||||
* {@link #UPGRADE}.
|
||||
*/
|
||||
UPGRADE_SKIPLOCKED( 10, "upgrade-skiplocked" ),
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ public enum LockMode {
|
|||
* A {@code WRITE} lock is obtained when an object is updated
|
||||
* or inserted. This lock mode is for internal use only and is
|
||||
* not a valid mode for {@code load()} or {@code lock()} (both
|
||||
* of which throw exceptions if WRITE is specified).
|
||||
* of which throw exceptions if {@code WRITE} is specified).
|
||||
*/
|
||||
WRITE( 10, "write" ),
|
||||
|
||||
|
|
|
|||
|
|
@ -173,9 +173,9 @@ public class LockOptions implements Serializable {
|
|||
}
|
||||
|
||||
/**
|
||||
* Does this LockOptions object define alias-specific lock modes?
|
||||
* Does this {@code LockOptions} instance define alias-specific lock modes?
|
||||
*
|
||||
* @return {@code true} if this LockOptions object define alias-specific lock modes; {@code false} otherwise.
|
||||
* @return {@code true} if this object defines alias-specific lock modes; {@code false} otherwise.
|
||||
*/
|
||||
public boolean hasAliasSpecificLockModes() {
|
||||
return aliasSpecificLockModes != null
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@
|
|||
package org.hibernate;
|
||||
|
||||
/**
|
||||
* Thrown when the application calls {@code Query.uniqueResult()} and
|
||||
* the query returned more than one result. Unlike all other Hibernate
|
||||
* exceptions, this one is recoverable!
|
||||
* Thrown when the application calls {@link org.hibernate.query.Query#uniqueResult()}
|
||||
* and the query returned more than one result. Unlike all other Hibernate exceptions,
|
||||
* this one is recoverable!
|
||||
*
|
||||
* @author Gavin King
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -538,9 +538,9 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
|
||||
/**
|
||||
* Obtain the specified lock level upon the given object. This may be used to
|
||||
* perform a version check ({@code LockMode.READ}), to upgrade to a pessimistic
|
||||
* lock ({@code LockMode.PESSIMISTIC_WRITE}), or to simply reassociate a transient instance
|
||||
* with a session ({@code LockMode.NONE}). This operation cascades to associated
|
||||
* perform a version check ({@link LockMode#READ}), to upgrade to a pessimistic
|
||||
* lock ({@link LockMode#PESSIMISTIC_WRITE}), or to simply reassociate a transient instance
|
||||
* with a session ({@link LockMode#NONE}). This operation cascades to associated
|
||||
* instances if the association is mapped with {@code cascade="lock"}.
|
||||
* <p/>
|
||||
* Convenient form of {@link LockRequest#lock(Object)} via {@link #buildLockRequest(LockOptions)}
|
||||
|
|
@ -555,9 +555,9 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
|
||||
/**
|
||||
* Obtain the specified lock level upon the given object. This may be used to
|
||||
* perform a version check ({@code LockMode.OPTIMISTIC}), to upgrade to a pessimistic
|
||||
* lock ({@code LockMode.PESSIMISTIC_WRITE}), or to simply reassociate a transient instance
|
||||
* with a session ({@code LockMode.NONE}). This operation cascades to associated
|
||||
* perform a version check ({@link LockMode#OPTIMISTIC}), to upgrade to a pessimistic
|
||||
* lock ({@link LockMode#PESSIMISTIC_WRITE}), or to simply reassociate a transient instance
|
||||
* with a session ({@link LockMode#NONE}). This operation cascades to associated
|
||||
* instances if the association is mapped with {@code cascade="lock"}.
|
||||
* <p/>
|
||||
* Convenient form of {@link LockRequest#lock(String, Object)} via {@link #buildLockRequest(LockOptions)}
|
||||
|
|
@ -593,7 +593,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
* <ul>
|
||||
* <li>where a database trigger alters the object state upon insert or update
|
||||
* <li>after executing direct SQL (eg. a mass update) in the same session
|
||||
* <li>after inserting a {@code Blob} or {@code Clob}
|
||||
* <li>after inserting a {@link java.sql.Blob} or {@link java.sql.Clob}
|
||||
* </ul>
|
||||
*
|
||||
* @param object a persistent or detached instance
|
||||
|
|
@ -608,7 +608,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
* <ul>
|
||||
* <li>where a database trigger alters the object state upon insert or update
|
||||
* <li>after executing direct SQL (eg. a mass update) in the same session
|
||||
* <li>after inserting a {@code Blob} or {@code Clob}
|
||||
* <li>after inserting a {@link java.sql.Blob} or {@link java.sql.Clob}
|
||||
* </ul>
|
||||
*
|
||||
* @param entityName a persistent class
|
||||
|
|
@ -618,7 +618,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
|
||||
/**
|
||||
* Re-read the state of the given instance from the underlying database, with
|
||||
* the given {@code LockMode}. It is inadvisable to use this to implement
|
||||
* the given {@link LockMode}. It is inadvisable to use this to implement
|
||||
* long-running sessions that span many business tasks. This method is, however,
|
||||
* useful in certain special circumstances.
|
||||
* <p/>
|
||||
|
|
@ -633,7 +633,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
|
||||
/**
|
||||
* Re-read the state of the given instance from the underlying database, with
|
||||
* the given {@code LockMode}. It is inadvisable to use this to implement
|
||||
* the given {@link LockMode}. It is inadvisable to use this to implement
|
||||
* long-running sessions that span many business tasks. This method is, however,
|
||||
* useful in certain special circumstances.
|
||||
*
|
||||
|
|
@ -644,7 +644,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
|
||||
/**
|
||||
* Re-read the state of the given instance from the underlying database, with
|
||||
* the given {@code LockMode}. It is inadvisable to use this to implement
|
||||
* the given {@link LockMode}. It is inadvisable to use this to implement
|
||||
* long-running sessions that span many business tasks. This method is, however,
|
||||
* useful in certain special circumstances.
|
||||
*
|
||||
|
|
@ -666,7 +666,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
/**
|
||||
* Completely clear the session. Evict all loaded instances and cancel all pending
|
||||
* saves, updates and deletions. Do not close open iterators or instances of
|
||||
* {@code ScrollableResults}.
|
||||
* {@link ScrollableResults}.
|
||||
*/
|
||||
void clear();
|
||||
|
||||
|
|
|
|||
|
|
@ -192,7 +192,7 @@ import static org.hibernate.internal.CoreLogging.messageLogger;
|
|||
/**
|
||||
* JSR 175 annotation binder which reads the annotations from classes, applies the
|
||||
* principles of the EJB3 spec and produces the Hibernate configuration-time metamodel
|
||||
* (the classes in the {@code org.hibernate.mapping} package)
|
||||
* (the classes in the {@link org.hibernate.mapping} package)
|
||||
* <p/>
|
||||
* Some design description
|
||||
* I tried to remove any link to annotation except from the 2 first level of
|
||||
|
|
|
|||
|
|
@ -1721,7 +1721,7 @@ public interface AvailableSettings {
|
|||
* valid value is {@code CONSTRAINT} and {@code NO_CONSTRAINT}.
|
||||
* </p>
|
||||
* <p>
|
||||
* The default value is CONSTRAINT.
|
||||
* The default value is {@code CONSTRAINT}.
|
||||
* </p>
|
||||
*
|
||||
* @since 5.4
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ import org.hibernate.AssertionFailure;
|
|||
import org.hibernate.internal.util.StringHelper;
|
||||
|
||||
/**
|
||||
* The default {@code NamingStrategy}
|
||||
* The default {@link NamingStrategy}
|
||||
*
|
||||
* @see ImprovedNamingStrategy a better alternative
|
||||
* @author Gavin King
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -28,10 +28,10 @@ import org.jboss.logging.Logger;
|
|||
* <p>
|
||||
* Hibernate has two property scopes:
|
||||
* <ul>
|
||||
* <li><b>Factory-level</b> properties may be passed to the {@code SessionFactory} when it
|
||||
* <li><em>Factory-level</em> properties may be passed to the {@code SessionFactory} when it
|
||||
* is instantiated. Each instance might have different property values. If no
|
||||
* properties are specified, the factory calls {@code Environment.getProperties()}.
|
||||
* <li><b>System-level</b> properties are shared by all factory instances and are always
|
||||
* <li><em>System-level</em> properties are shared by all factory instances and are always
|
||||
* determined by the {@code Environment} properties.
|
||||
* </ul>
|
||||
* The only system-level properties are
|
||||
|
|
@ -39,32 +39,31 @@ import org.jboss.logging.Logger;
|
|||
* <li>{@code hibernate.jdbc.use_streams_for_binary}
|
||||
* <li>{@code hibernate.cglib.use_reflection_optimizer}
|
||||
* </ul>
|
||||
* {@code Environment} properties are populated by calling {@code System.getProperties()}
|
||||
* {@code Environment} properties are populated by calling {@link System#getProperties()}
|
||||
* and then from a resource named {@code /hibernate.properties} if it exists. System
|
||||
* properties override properties specified in {@code hibernate.properties}.
|
||||
* <p>
|
||||
* The {@code SessionFactory} is controlled by the following properties.
|
||||
* Properties may be either be {@code System} properties, properties
|
||||
* defined in a resource named {@code /hibernate.properties} or an instance of
|
||||
* {@code java.util.Properties} passed to
|
||||
* {@code Configuration.build()}
|
||||
* The {@link org.hibernate.SessionFactory} is controlled by the following properties.
|
||||
* Properties may be either be {@link System} properties, properties defined in a
|
||||
* resource named {@code /hibernate.properties} or an instance of
|
||||
* {@link java.util.Properties} passed to {@link Configuration#addProperties(Properties)}.
|
||||
* <p>
|
||||
* <table>
|
||||
* <tr><td><b>property</b></td><td><b>meaning</b></td></tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.dialect}</td>
|
||||
* <td>classname of {@code org.hibernate.dialect.Dialect} subclass</td>
|
||||
* <td>classname of {@link org.hibernate.dialect.Dialect} subclass</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.connection.provider_class}</td>
|
||||
* <td>classname of {@code ConnectionProvider}
|
||||
* <td>name of a {@link org.hibernate.engine.jdbc.connections.spi.ConnectionProvider}
|
||||
* subclass (if not specified heuristics are used)</td>
|
||||
* </tr>
|
||||
* <tr><td>{@code hibernate.connection.username}</td><td>database username</td></tr>
|
||||
* <tr><td>{@code hibernate.connection.password}</td><td>database password</td></tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.connection.url}</td>
|
||||
* <td>JDBC URL (when using {@code java.sql.DriverManager})</td>
|
||||
* <td>JDBC URL (when using {@link java.sql.DriverManager})</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.connection.driver_class}</td>
|
||||
|
|
@ -73,23 +72,23 @@ import org.jboss.logging.Logger;
|
|||
* <tr>
|
||||
* <td>{@code hibernate.connection.isolation}</td>
|
||||
* <td>JDBC transaction isolation level (only when using
|
||||
* {@code java.sql.DriverManager})
|
||||
* {@link java.sql.DriverManager})
|
||||
* </td>
|
||||
* </tr>
|
||||
* <td>{@code hibernate.connection.pool_size}</td>
|
||||
* <td>the maximum size of the connection pool (only when using
|
||||
* {@code java.sql.DriverManager})
|
||||
* {@link java.sql.DriverManager})
|
||||
* </td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.connection.datasource}</td>
|
||||
* <td>datasource JNDI name (when using {@code javax.sql.Datasource})</td>
|
||||
* <td>datasource JNDI name (when using {@link javax.sql.DataSource})</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.jndi.url}</td><td>JNDI {@code InitialContext} URL</td>
|
||||
* <td>{@code hibernate.jndi.url}</td><td>JNDI {@link javax.naming.InitialContext} URL</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.jndi.class}</td><td>JNDI {@code InitialContext} classname</td>
|
||||
* <td>{@code hibernate.jndi.class}</td><td>JNDI {@link javax.naming.InitialContext} classname</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.max_fetch_depth}</td>
|
||||
|
|
@ -133,17 +132,9 @@ import org.jboss.logging.Logger;
|
|||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.transaction.jta.platform}</td>
|
||||
* <td>classname of {@code org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform}
|
||||
* <td>classname of {@link org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform}
|
||||
* implementor</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.transaction.factory_class}</td>
|
||||
* <td>the factory to use for instantiating {@code Transaction}s.
|
||||
* (Defaults to {@code JdbcTransactionFactory}.)</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>{@code hibernate.query.substitutions}</td><td>query language token substitutions</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* @see org.hibernate.SessionFactory
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ import org.hibernate.internal.util.StringHelper;
|
|||
/**
|
||||
* An improved naming strategy that prefers embedded
|
||||
* underscores to mixed case names
|
||||
*
|
||||
* @see DefaultNamingStrategy the default strategy
|
||||
* @author Gavin King
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ import org.hibernate.engine.spi.SharedSessionContractImplementor;
|
|||
* <p>
|
||||
* Alternatively, custom types could implement {@code Type}
|
||||
* directly or extend one of the abstract classes in
|
||||
* {@code org.hibernate.type}. This approach risks future
|
||||
* {@link org.hibernate.type}. This approach risks future
|
||||
* incompatible changes to classes or interfaces in that
|
||||
* package.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import org.hibernate.testing.orm.junit.RequiresDialect;
|
|||
import org.hibernate.testing.TestForIssue;
|
||||
|
||||
/**
|
||||
* Test to illustrate that the {@code org.hibernate.mapping.Table#sqlAlterStrings} method
|
||||
* Test to illustrate that the {@link org.hibernate.mapping.Table#sqlAlterStrings} method
|
||||
* uses legacy logic for building table names and doesn't adequately specify the catalog
|
||||
* or schema name properly.
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in New Issue