minor javadoc clarifications

This commit is contained in:
Gavin 2022-12-22 15:45:05 +01:00
parent 748ebe8456
commit 1cd183b999
2 changed files with 28 additions and 5 deletions

View File

@ -50,14 +50,16 @@ public final class Length {
/** /**
* The maximum length that fits in 16 bits. * The maximum length that fits in 16 bits.
* Used to select a variable-length SQL type large * Used to select a variable-length SQL type large
* enough to contain values of maximum length 32767. * enough to accommodate values of maximum length
* {@value Short#MAX_VALUE}.
*/ */
public static final int LONG16 = Short.MAX_VALUE; public static final int LONG16 = Short.MAX_VALUE;
/** /**
* The maximum length of a Java string, that is, * The maximum length of a Java string or array,
* the maximum length that fits in 32 bits. * that is, the maximum length that fits in 32 bits.
* Used to select a variable-length SQL type large * Used to select a variable-length SQL type large
* enough to contain any Java string. * enough to accommodate any Java string up to the
* maximum possible length {@value Integer#MAX_VALUE}.
* <p> * <p>
* This is also the default length for a column * This is also the default length for a column
* declared using * declared using

View File

@ -137,6 +137,9 @@ public class SqlTypes {
* <p> * <p>
* Interpreted by Hibernate as a {@link #VARCHAR}-like type large enough * Interpreted by Hibernate as a {@link #VARCHAR}-like type large enough
* to hold a string of maximum length {@link org.hibernate.Length#LONG}. * to hold a string of maximum length {@link org.hibernate.Length#LONG}.
* <p>
* Apart from the larger default column length, this type code is treated
* as a synonym for {@link #VARCHAR}.
* *
* @see org.hibernate.Length#LONG * @see org.hibernate.Length#LONG
* *
@ -149,6 +152,10 @@ public class SqlTypes {
* A type code used internally by the Hibernate * A type code used internally by the Hibernate
* {@link org.hibernate.dialect.Dialect} to identify a * {@link org.hibernate.dialect.Dialect} to identify a
* {@link #VARCHAR}-like type large enough to hold any Java string. * {@link #VARCHAR}-like type large enough to hold any Java string.
* <p>
* In principle, the type must accommodate strings of length
* {@value Integer#MAX_VALUE}, though this is not an absolutely hard
* requirement, since such large strings do not occur in practice.
* *
* @see org.hibernate.Length#LONG32 * @see org.hibernate.Length#LONG32
*/ */
@ -199,6 +206,9 @@ public class SqlTypes {
* <p> * <p>
* Interpreted by Hibernate as a {@link #VARBINARY}-like type large enough * Interpreted by Hibernate as a {@link #VARBINARY}-like type large enough
* to hold a byte array of maximum length {@link org.hibernate.Length#LONG}. * to hold a byte array of maximum length {@link org.hibernate.Length#LONG}.
* <p>
* Apart from the larger default column length, this type code is treated
* as a synonym for {@link #VARBINARY}.
* *
* @see org.hibernate.Length#LONG * @see org.hibernate.Length#LONG
* *
@ -208,9 +218,13 @@ public class SqlTypes {
public final static int LONGVARBINARY = Types.LONGVARBINARY; public final static int LONGVARBINARY = Types.LONGVARBINARY;
/** /**
* A type code used internally by the Hibernate SQL * A type code used by the Hibernate SQL
* {@linkplain org.hibernate.dialect.Dialect dialect} to identify a * {@linkplain org.hibernate.dialect.Dialect dialect} to identify a
* {@link #VARBINARY}-like type large enough to hold any Java byte array. * {@link #VARBINARY}-like type large enough to hold any Java byte array.
* <p>
* In principle, the type must accommodate arrays of length
* {@value Integer#MAX_VALUE}, though this is not an absolutely hard
* requirement, since such large arrays do not occur in practice.
* *
* @see org.hibernate.Length#LONG32 * @see org.hibernate.Length#LONG32
*/ */
@ -330,6 +344,9 @@ public class SqlTypes {
* <p> * <p>
* Interpreted by Hibernate as an {@link #NVARCHAR}-like type large enough * Interpreted by Hibernate as an {@link #NVARCHAR}-like type large enough
* to hold a string of maximum length {@link org.hibernate.Length#LONG}. * to hold a string of maximum length {@link org.hibernate.Length#LONG}.
* <p>
* Apart from the larger default column length, this type code is treated
* as a synonym for {@link #NVARCHAR}.
* *
* @see org.hibernate.Length#LONG * @see org.hibernate.Length#LONG
* *
@ -342,6 +359,10 @@ public class SqlTypes {
* A type code used internally by the Hibernate * A type code used internally by the Hibernate
* {@link org.hibernate.dialect.Dialect} to identify an * {@link org.hibernate.dialect.Dialect} to identify an
* {@link #NVARCHAR}-like type large enough to hold any Java string. * {@link #NVARCHAR}-like type large enough to hold any Java string.
* <p>
* In principle, the type must accommodate strings of length
* {@value Integer#MAX_VALUE}, though this is not an absolutely hard
* requirement, since such large strings do not occur in practice.
* *
* @see org.hibernate.Length#LONG32 * @see org.hibernate.Length#LONG32
*/ */