8040147: minor cleanup for docs

Minor cleanup for docs

Reviewed-by: lancea
This commit is contained in:
Alexander Stepanov 2015-05-26 18:31:21 +04:00
parent 4f8755f9b8
commit 60ea3cb98f
16 changed files with 349 additions and 331 deletions

View File

@ -5176,7 +5176,7 @@ public class BigDecimal extends Number implements Comparable<BigDecimal> {
}
/*
* returns true if 128 bit number <hi0,lo0> is less then <hi1,lo1>
* returns true if 128 bit number <hi0,lo0> is less than <hi1,lo1>
* hi0 & hi1 should be non-negative
*/
private static boolean longLongCompareMagnitude(long hi0, long lo0, long hi1, long lo1) {

View File

@ -332,7 +332,7 @@ public class AttributedString {
* @param beginIndex Index of the first character of the range.
* @param endIndex Index of the character following the last character of the range.
* @exception NullPointerException if <code>attribute</code> is null.
* @exception IllegalArgumentException if beginIndex is less then 0, endIndex is
* @exception IllegalArgumentException if beginIndex is less than 0, endIndex is
* greater than the length of the string, or beginIndex and endIndex together don't
* define a non-empty subrange of the string.
*/
@ -357,7 +357,7 @@ public class AttributedString {
* @param endIndex Index of the character following the last
* character of the range.
* @exception NullPointerException if <code>attributes</code> is null.
* @exception IllegalArgumentException if beginIndex is less then
* @exception IllegalArgumentException if beginIndex is less than
* 0, endIndex is greater than the length of the string, or
* beginIndex and endIndex together don't define a non-empty
* subrange of the string and the attributes parameter is not an
@ -580,7 +580,7 @@ public class AttributedString {
* @param beginIndex the index of the first character
* @param endIndex the index of the character following the last character
* @return an iterator providing access to the text and its attributes
* @exception IllegalArgumentException if beginIndex is less then 0,
* @exception IllegalArgumentException if beginIndex is less than 0,
* endIndex is greater than the length of the string, or beginIndex is
* greater than endIndex.
*/

View File

@ -162,8 +162,8 @@ public abstract class Parser {
* Possible character type values are:<br> - 0 for underscore ('_') or any
* lower and upper case alphabetical character value;<br> - 1 for colon
* (':') character;<br> - 2 for dash ('-') and dot ('.') or any decimal
* digit character value;<br> - 3 for any kind of white space character<br
* /> An ASCII (7 bit) character which does not fall in any category listed
* digit character value;<br> - 3 for any kind of white space character<br>
* An ASCII (7 bit) character which does not fall in any category listed
* above is mapped to 0xff.
*/
private static final byte nmttyp[];

View File

@ -1040,7 +1040,7 @@ public class CNCtx implements javax.naming.Context {
/**
* Allow access to the name parser object.
* @param String JNDI name, is ignored since there is only one Name
* @param name JNDI name, is ignored since there is only one Name
* Parser object.
* @exception NamingException --
* @return NameParser object
@ -1051,7 +1051,7 @@ public class CNCtx implements javax.naming.Context {
/**
* Allow access to the name parser object.
* @param Name JNDI name, is ignored since there is only one Name
* @param name JNDI name, is ignored since there is only one Name
* Parser object.
* @exception NamingException --
* @return NameParser object
@ -1088,7 +1088,7 @@ public class CNCtx implements javax.naming.Context {
* Record change but do not reinitialize ORB.
*
* @param propName The property name.
* @param propVal The ORB.
* @param propValue The ORB.
* @return the previous value of this property if any.
*/
@SuppressWarnings("unchecked")

View File

@ -35,32 +35,36 @@ import com.sun.jndi.toolkit.url.UrlUtil;
* Extract components of a "corbaname" URL.
*
* The format of an corbaname URL is defined in INS 99-12-03 as follows.
*<p>
* <pre>{@code
* corbaname url = "corbaname:" <corbaloc_obj> ["#" <string_name>]
* corbaloc_obj = <obj_addr_list> ["/" <key_string>]
* obj_addr_list = as defined in a corbaloc URL
* key_string = as defined in a corbaloc URL
* string_name = stringified COS name | empty_string
*<p>
* Characters in <string_name> are escaped as follows.
* }</pre>
* Characters in {@code <string_name>} are escaped as follows.
* US-ASCII alphanumeric characters are not escaped. Any characters outside
* of this range are escaped except for the following:
* <pre>{@code
* ; / : ? @ & = + $ , - _ . ! ~ * ; ( )
* }</pre>
* Escaped characters is escaped by using a % followed by its 2 hexadecimal
* numbers representing the octet.
*<p>
* <p>
* The corbaname URL is parsed into two parts: a corbaloc URL and a COS name.
* The corbaloc URL is constructed by concatenation "corbaloc:" with
* <corbaloc_obj>.
* The COS name is <string_name> with the escaped characters resolved.
*<p>
* The corbaloc URL is constructed by concatenation {@code "corbaloc:"} with
* {@code <corbaloc_obj>}.
* The COS name is {@code <string_name>} with the escaped characters resolved.
* <p>
* A corbaname URL is resolved by:
*<ol>
*<li>Construct a corbaloc URL by concatenating "corbaloc:" and <corbaloc_obj>.
*<li>Resolve the corbaloc URL to a NamingContext by using
* <ol>
* <li>Construct a corbaloc URL by concatenating {@code "corbaloc:"} and {@code <corbaloc_obj>}.
* <li>Resolve the corbaloc URL to a NamingContext by using
* <pre>{@code
* nctx = ORB.string_to_object(corbalocUrl);
*<li>Resolve <string_name> in the NamingContext.
*</ol>
* }</pre>
* <li>Resolve {@code <string_name>} in the NamingContext.
* </ol>
*
* @author Rosanna Lee
*/

View File

@ -38,6 +38,7 @@ import com.sun.jndi.toolkit.url.UrlUtil;
*
* The format of an iiopname URL is defined in INS 98-10-11 as follows:
*
* <pre>
* iiopname url = "iiopname://" [addr_list]["/" string_name]
* addr_list = [address ","]* address
* address = [version host [":" port]]
@ -46,19 +47,23 @@ import com.sun.jndi.toolkit.url.UrlUtil;
* port = number
* major = number
* minor = number
* string_name = stringified name | empty_string
* string_name = stringified name | empty_string
* </pre>
*
* The default port is 9999. The default version is "1.0"
* US-ASCII alphanumeric characters are not escaped. Any characters outside
* of this range are escaped except for the following:
* <pre>{@code
* ; / : ? : @ & = + $ , - _ . ! ~ * ' ( )
* }</pre>
* Escaped characters is escaped by using a % followed by its 2 hexadecimal
* numbers representing the octet.
*
* For backward compatibility, the "iiop" URL as defined in INS 97-6-6
* is also supported:
*
* <pre>{@code
* iiop url = "iiop://" [host [":" port]] ["/" string_name]
* }</pre>
* The default port is 900.
*
* @author Rosanna Lee

View File

@ -56,7 +56,7 @@ public class CorbaUtils {
* object by using the javax.rmi.CORBA package.
*<p>
* This method effective does the following:
*<blockquote><pre>
* <blockquote><pre>
* java.lang.Object stub;
* try {
* stub = PortableRemoteObject.toStub(remoteObj);
@ -72,6 +72,7 @@ public class CorbaUtils {
* // ignore 'already connected' error
* }
* return (javax.rmi.CORBA.Stub)stub;
* </pre></blockquote>
*
* @param remoteObj The non-null remote object for
* @param orb The non-null ORB to connect the remote object to

View File

@ -1059,7 +1059,7 @@ public class CachedRowSetImpl extends BaseRowSet implements RowSet, RowSetIntern
* (<code>acceptChanges</code>) or population. This method may also be called
* while performing updates to the insert row.
* <P>
* <code>undoUpdate</code may be called at any time during the life-time of a
* {@code undoUpdate} may be called at any time during the life-time of a
* rowset, however after a synchronization has occurs this method has no
* affect until further modification to the RowSet data occurs.
*
@ -2467,10 +2467,11 @@ public class CachedRowSetImpl extends BaseRowSet implements RowSet, RowSetIntern
* @throws SQLException if (1) the given column name is not the name of
* a column in this rowset, (2) the cursor is not on one of
* this rowset's rows or its insert row, or (3) the designated
* column does not store an SQL <code>TINYINT, SMALLINT, INTEGER
* BIGINT, REAL, FLOAT, DOUBLE, DECIMAL, NUMERIC, BIT, <b>CHAR</b>,
* <b>VARCHAR</b></code> or <code>LONGVARCHAR<</code> value. The bold SQL type
* designates the recommended return type.
* column does not store an SQL {@code TINYINT, SMALLINT, INTEGER
* BIGINT, REAL, FLOAT, DOUBLE, DECIMAL, NUMERIC, BIT, }
* <b>{@code CHAR, VARCHAR}</b> or
* <b>{@code LONGVARCHAR}</b> value.
* The bold SQL type designates the recommended return type.
*/
public String getString(String columnName) throws SQLException {
return getString(getColIdxByName(columnName));
@ -7748,7 +7749,7 @@ public class CachedRowSetImpl extends BaseRowSet implements RowSet, RowSetIntern
* Updates the designated column with a <code>RowId</code> value. The updater
* methods are used to update column values in the current row or the insert
* row. The updater methods do not update the underlying database; instead
* the <code>updateRow<code> or <code>insertRow</code> methods are called
* the {@code updateRow} or {@code insertRow} methods are called
* to update the database.
*
* @param columnIndex the first column is 1, the second 2, ...
@ -7764,7 +7765,7 @@ public class CachedRowSetImpl extends BaseRowSet implements RowSet, RowSetIntern
* Updates the designated column with a <code>RowId</code> value. The updater
* methods are used to update column values in the current row or the insert
* row. The updater methods do not update the underlying database; instead
* the <code>updateRow<code> or <code>insertRow</code> methods are called
* the {@code updateRow} or {@code insertRow} methods are called
* to update the database.
*
* @param columnName the name of the column

View File

@ -182,7 +182,7 @@ public class CachedRowSetWriter implements TransactionalWriter, Serializable {
private CachedRowSetImpl crsResolve;
/**
* This <code>ArrayList<code> will hold the values of SyncResolver.*
* This {@code ArrayList} will hold the values of SyncResolver.*
*/
private ArrayList<Integer> status;

View File

@ -29,29 +29,28 @@ import java.io.InputStream;
/**
* The representation (mapping) in
* the Java&trade; programming
* language of an SQL
* <code>BLOB</code> value. An SQL <code>BLOB</code> is a built-in type
* the Java&trade; programming language of an SQL
* {@code BLOB} value. An SQL {@code BLOB} is a built-in type
* that stores a Binary Large Object as a column value in a row of
* a database table. By default drivers implement <code>Blob</code> using
* an SQL <code>locator(BLOB)</code>, which means that a
* <code>Blob</code> object contains a logical pointer to the
* SQL <code>BLOB</code> data rather than the data itself.
* A <code>Blob</code> object is valid for the duration of the
* a database table. By default drivers implement {@code Blob} using
* an SQL {@code locator(BLOB)}, which means that a
* {@code Blob} object contains a logical pointer to the
* SQL {@code BLOB} data rather than the data itself.
* A {@code Blob} object is valid for the duration of the
* transaction in which is was created.
*
* <P>Methods in the interfaces {@link ResultSet},
* {@link CallableStatement}, and {@link PreparedStatement}, such as
* <code>getBlob</code> and <code>setBlob</code> allow a programmer to
* access an SQL <code>BLOB</code> value.
* The <code>Blob</code> interface provides methods for getting the
* length of an SQL <code>BLOB</code> (Binary Large Object) value,
* for materializing a <code>BLOB</code> value on the client, and for
* {@code getBlob} and {@code setBlob} allow a programmer to
* access an SQL {@code BLOB} value.
* The {@code Blob} interface provides methods for getting the
* length of an SQL {@code BLOB} (Binary Large Object) value,
* for materializing a {@code BLOB} value on the client, and for
* determining the position of a pattern of bytes within a
* <code>BLOB</code> value. In addition, this interface has methods for updating
* a <code>BLOB</code> value.
* {@code BLOB} value. In addition, this interface has methods for updating
* a {@code BLOB} value.
* <p>
* All methods on the <code>Blob</code> interface must be fully implemented if the
* All methods on the {@code Blob} interface must be fully implemented if the
* JDBC driver supports the data type.
*
* @since 1.2
@ -60,51 +59,52 @@ import java.io.InputStream;
public interface Blob {
/**
* Returns the number of bytes in the <code>BLOB</code> value
* designated by this <code>Blob</code> object.
* @return length of the <code>BLOB</code> in bytes
* Returns the number of bytes in the {@code BLOB} value
* designated by this {@code Blob} object.
*
* @return length of the {@code BLOB} in bytes
* @exception SQLException if there is an error accessing the
* length of the <code>BLOB</code>
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* length of the {@code BLOB}
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.2
*/
long length() throws SQLException;
/**
* Retrieves all or part of the <code>BLOB</code>
* value that this <code>Blob</code> object represents, as an array of
* bytes. This <code>byte</code> array contains up to <code>length</code>
* consecutive bytes starting at position <code>pos</code>.
* Retrieves all or part of the {@code BLOB}
* value that this {@code Blob} object represents, as an array of
* bytes. This {@code byte} array contains up to {@code length}
* consecutive bytes starting at position {@code pos}.
*
* @param pos the ordinal position of the first byte in the
* <code>BLOB</code> value to be extracted; the first byte is at
* {@code BLOB} value to be extracted; the first byte is at
* position 1
* @param length the number of consecutive bytes to be copied; the value
* for length must be 0 or greater
* @return a byte array containing up to <code>length</code>
* consecutive bytes from the <code>BLOB</code> value designated
* by this <code>Blob</code> object, starting with the
* byte at position <code>pos</code>
* for length must be 0 or greater
* @return a byte array containing up to {@code length}
* consecutive bytes from the {@code BLOB} value designated
* by this {@code Blob} object, starting with the
* byte at position {@code pos}
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> value; if pos is less than 1 or length is
* less than 0
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} value; if pos is less than 1 or length is
* less than 0
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #setBytes
* @since 1.2
*/
byte[] getBytes(long pos, int length) throws SQLException;
/**
* Retrieves the <code>BLOB</code> value designated by this
* <code>Blob</code> instance as a stream.
* Retrieves the {@code BLOB} value designated by this
* {@code Blob} instance as a stream.
*
* @return a stream containing the <code>BLOB</code> data
* @return a stream containing the {@code BLOB} data
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> value
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} value
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #setBinaryStream
* @since 1.2
*/
@ -112,38 +112,38 @@ public interface Blob {
/**
* Retrieves the byte position at which the specified byte array
* <code>pattern</code> begins within the <code>BLOB</code>
* value that this <code>Blob</code> object represents. The
* search for <code>pattern</code> begins at position
* <code>start</code>.
* {@code pattern} begins within the {@code BLOB}
* value that this {@code Blob} object represents.
* The search for {@code pattern} begins at position
* {@code start}.
*
* @param pattern the byte array for which to search
* @param start the position at which to begin searching; the
* first position is 1
* @return the position at which the pattern appears, else -1
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> or if start is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} or if start is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.2
*/
long position(byte pattern[], long start) throws SQLException;
/**
* Retrieves the byte position in the <code>BLOB</code> value
* designated by this <code>Blob</code> object at which
* <code>pattern</code> begins. The search begins at position
* <code>start</code>.
* Retrieves the byte position in the {@code BLOB} value
* designated by this {@code Blob} object at which
* {@code pattern} begins. The search begins at position
* {@code start}.
*
* @param pattern the <code>Blob</code> object designating
* the <code>BLOB</code> value for which to search
* @param start the position in the <code>BLOB</code> value
* @param pattern the {@code Blob} object designating
* the {@code BLOB} value for which to search
* @param start the position in the {@code BLOB} value
* at which to begin searching; the first position is 1
* @return the position at which the pattern begins, else -1
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> value or if start is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} value or if start is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.2
*/
long position(Blob pattern, long start) throws SQLException;
@ -151,152 +151,155 @@ public interface Blob {
// -------------------------- JDBC 3.0 -----------------------------------
/**
* Writes the given array of bytes to the <code>BLOB</code> value that
* this <code>Blob</code> object represents, starting at position
* <code>pos</code>, and returns the number of bytes written.
* Writes the given array of bytes to the {@code BLOB} value that
* this {@code Blob} object represents, starting at position
* {@code pos}, and returns the number of bytes written.
* The array of bytes will overwrite the existing bytes
* in the <code>Blob</code> object starting at the position
* <code>pos</code>. If the end of the <code>Blob</code> value is reached
* while writing the array of bytes, then the length of the <code>Blob</code>
* in the {@code Blob} object starting at the position
* {@code pos}. If the end of the {@code Blob} value is reached
* while writing the array of bytes, then the length of the {@code Blob}
* value will be increased to accommodate the extra bytes.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>BLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code BLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param pos the position in the <code>BLOB</code> object at which
* @param pos the position in the {@code BLOB} object at which
* to start writing; the first position is 1
* @param bytes the array of bytes to be written to the <code>BLOB</code>
* value that this <code>Blob</code> object represents
* @param bytes the array of bytes to be written to the {@code BLOB}
* value that this {@code Blob} object represents
* @return the number of bytes written
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #getBytes
* @since 1.4
*/
int setBytes(long pos, byte[] bytes) throws SQLException;
/**
* Writes all or part of the given <code>byte</code> array to the
* <code>BLOB</code> value that this <code>Blob</code> object represents
* Writes all or part of the given {@code byte} array to the
* {@code BLOB} value that this {@code Blob} object represents
* and returns the number of bytes written.
* Writing starts at position <code>pos</code> in the <code>BLOB</code>
* value; <code>len</code> bytes from the given byte array are written.
* Writing starts at position {@code pos} in the {@code BLOB}
* value; {@code len} bytes from the given byte array are written.
* The array of bytes will overwrite the existing bytes
* in the <code>Blob</code> object starting at the position
* <code>pos</code>. If the end of the <code>Blob</code> value is reached
* while writing the array of bytes, then the length of the <code>Blob</code>
* in the {@code Blob} object starting at the position
* {@code pos}. If the end of the {@code Blob} value is reached
* while writing the array of bytes, then the length of the {@code Blob}
* value will be increased to accommodate the extra bytes.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>BLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code BLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param pos the position in the <code>BLOB</code> object at which
* @param pos the position in the {@code BLOB} object at which
* to start writing; the first position is 1
* @param bytes the array of bytes to be written to this <code>BLOB</code>
* @param bytes the array of bytes to be written to this {@code BLOB}
* object
* @param offset the offset into the array <code>bytes</code> at which
* @param offset the offset into the array {@code bytes} at which
* to start reading the bytes to be set
* @param len the number of bytes to be written to the <code>BLOB</code>
* value from the array of bytes <code>bytes</code>
* @param len the number of bytes to be written to the {@code BLOB}
* value from the array of bytes {@code bytes}
* @return the number of bytes written
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #getBytes
* @since 1.4
*/
int setBytes(long pos, byte[] bytes, int offset, int len) throws SQLException;
/**
* Retrieves a stream that can be used to write to the <code>BLOB</code>
* value that this <code>Blob</code> object represents. The stream begins
* at position <code>pos</code>.
* Retrieves a stream that can be used to write to the {@code BLOB}
* value that this {@code Blob} object represents. The stream begins
* at position {@code pos}.
* The bytes written to the stream will overwrite the existing bytes
* in the <code>Blob</code> object starting at the position
* <code>pos</code>. If the end of the <code>Blob</code> value is reached
* while writing to the stream, then the length of the <code>Blob</code>
* in the {@code Blob} object starting at the position
* {@code pos}. If the end of the {@code Blob} value is reached
* while writing to the stream, then the length of the {@code Blob}
* value will be increased to accommodate the extra bytes.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>BLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code BLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param pos the position in the <code>BLOB</code> value at which
* @param pos the position in the {@code BLOB} value at which
* to start writing; the first position is 1
* @return a <code>java.io.OutputStream</code> object to which data can
* @return a {@code java.io.OutputStream} object to which data can
* be written
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #getBinaryStream
* @since 1.4
*/
java.io.OutputStream setBinaryStream(long pos) throws SQLException;
/**
* Truncates the <code>BLOB</code> value that this <code>Blob</code>
* object represents to be <code>len</code> bytes in length.
* Truncates the {@code BLOB} value that this {@code Blob}
* object represents to be {@code len} bytes in length.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>BLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code BLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param len the length, in bytes, to which the <code>BLOB</code> value
* that this <code>Blob</code> object represents should be truncated
* @param len the length, in bytes, to which the {@code BLOB} value
* that this {@code Blob} object represents should be truncated
* @exception SQLException if there is an error accessing the
* <code>BLOB</code> value or if len is less than 0
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code BLOB} value or if len is less than 0
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.4
*/
void truncate(long len) throws SQLException;
/**
* This method frees the <code>Blob</code> object and releases the resources that
* it holds. The object is invalid once the <code>free</code>
* This method frees the {@code Blob} object and releases the resources that
* it holds. The object is invalid once the {@code free}
* method is called.
* <p>
* After <code>free</code> has been called, any attempt to invoke a
* method other than <code>free</code> will result in a <code>SQLException</code>
* being thrown. If <code>free</code> is called multiple times, the subsequent
* calls to <code>free</code> are treated as a no-op.
* After {@code free} has been called, any attempt to invoke a
* method other than {@code free} will result in an {@code SQLException}
* being thrown. If {@code free} is called multiple times, the subsequent
* calls to {@code free} are treated as a no-op.
*
* @throws SQLException if an error occurs releasing
* the Blob's resources
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* the Blob's resources
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.6
*/
void free() throws SQLException;
/**
* Returns an <code>InputStream</code> object that contains a partial <code>Blob</code> value,
* starting with the byte specified by pos, which is length bytes in length.
* Returns an {@code InputStream} object that contains
* a partial {@code Blob} value, starting with the byte
* specified by pos, which is length bytes in length.
*
* @param pos the offset to the first byte of the partial value to be retrieved.
* The first byte in the <code>Blob</code> is at position 1
* @param pos the offset to the first byte of the partial value to be
* retrieved. The first byte in the {@code Blob} is at position 1.
* @param length the length in bytes of the partial value to be retrieved
* @return <code>InputStream</code> through which the partial <code>Blob</code> value can be read.
* @throws SQLException if pos is less than 1 or if pos is greater than the number of bytes
* in the <code>Blob</code> or if pos + length is greater than the number of bytes
* in the <code>Blob</code>
* @return {@code InputStream} through which
* the partial {@code Blob} value can be read.
* @throws SQLException if pos is less than 1 or if pos is greater
* than the number of bytes in the {@code Blob} or if
* pos + length is greater than the number of bytes
* in the {@code Blob}
*
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.6
*/
InputStream getBinaryStream(long pos, long length) throws SQLException;

View File

@ -29,28 +29,28 @@ import java.io.Reader;
/**
* The mapping in the Java&trade; programming language
* for the SQL <code>CLOB</code> type.
* An SQL <code>CLOB</code> is a built-in type
* for the SQL {@code CLOB} type.
* An SQL {@code CLOB} is a built-in type
* that stores a Character Large Object as a column value in a row of
* a database table.
* By default drivers implement a <code>Clob</code> object using an SQL
* <code>locator(CLOB)</code>, which means that a <code>Clob</code> object
* contains a logical pointer to the SQL <code>CLOB</code> data rather than
* the data itself. A <code>Clob</code> object is valid for the duration
* By default drivers implement a {@code Clob} object using an SQL
* {@code locator(CLOB)}, which means that a {@code Clob} object
* contains a logical pointer to the SQL {@code CLOB} data rather than
* the data itself. A {@code Clob} object is valid for the duration
* of the transaction in which it was created.
* <P>The <code>Clob</code> interface provides methods for getting the
* length of an SQL <code>CLOB</code> (Character Large Object) value,
* for materializing a <code>CLOB</code> value on the client, and for
* searching for a substring or <code>CLOB</code> object within a
* <code>CLOB</code> value.
* <P>The {@code Clob} interface provides methods for getting the
* length of an SQL {@code CLOB} (Character Large Object) value,
* for materializing a {@code CLOB} value on the client, and for
* searching for a substring or {@code CLOB} object within a
* {@code CLOB} value.
* Methods in the interfaces {@link ResultSet},
* {@link CallableStatement}, and {@link PreparedStatement}, such as
* <code>getClob</code> and <code>setClob</code> allow a programmer to
* access an SQL <code>CLOB</code> value. In addition, this interface
* has methods for updating a <code>CLOB</code> value.
* {@code getClob} and {@code setClob} allow a programmer to
* access an SQL {@code CLOB} value. In addition, this interface
* has methods for updating a {@code CLOB} value.
* <p>
* All methods on the <code>Clob</code> interface must be fully implemented if the
* JDBC driver supports the data type.
* All methods on the {@code Clob} interface must be
* fully implemented if the JDBC driver supports the data type.
*
* @since 1.2
*/
@ -59,67 +59,67 @@ public interface Clob {
/**
* Retrieves the number of characters
* in the <code>CLOB</code> value
* designated by this <code>Clob</code> object.
* in the {@code CLOB} value
* designated by this {@code Clob} object.
*
* @return length of the <code>CLOB</code> in characters
* @return length of the {@code CLOB} in characters
* @exception SQLException if there is an error accessing the
* length of the <code>CLOB</code> value
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* length of the {@code CLOB} value
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.2
*/
long length() throws SQLException;
/**
* Retrieves a copy of the specified substring
* in the <code>CLOB</code> value
* designated by this <code>Clob</code> object.
* in the {@code CLOB} value
* designated by this {@code Clob} object.
* The substring begins at position
* <code>pos</code> and has up to <code>length</code> consecutive
* {@code pos} and has up to {@code length} consecutive
* characters.
*
* @param pos the first character of the substring to be extracted.
* The first character is at position 1.
* The first character is at position 1.
* @param length the number of consecutive characters to be copied;
* the value for length must be 0 or greater
* @return a <code>String</code> that is the specified substring in
* the <code>CLOB</code> value designated by this <code>Clob</code> object
* the value for length must be 0 or greater
* @return a {@code String} that is the specified substring in
* the {@code CLOB} value designated by this {@code Clob} object
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value; if pos is less than 1 or length is
* less than 0
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code CLOB} value; if pos is less than 1 or length is
* less than 0
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.2
*/
String getSubString(long pos, int length) throws SQLException;
/**
* Retrieves the <code>CLOB</code> value designated by this <code>Clob</code>
* object as a <code>java.io.Reader</code> object (or as a stream of
* Retrieves the {@code CLOB} value designated by this {@code Clob}
* object as a {@code java.io.Reader} object (or as a stream of
* characters).
*
* @return a <code>java.io.Reader</code> object containing the
* <code>CLOB</code> data
* @return a {@code java.io.Reader} object containing the
* {@code CLOB} data
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code CLOB} value
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #setCharacterStream
* @since 1.2
*/
java.io.Reader getCharacterStream() throws SQLException;
/**
* Retrieves the <code>CLOB</code> value designated by this <code>Clob</code>
* Retrieves the {@code CLOB} value designated by this {@code Clob}
* object as an ascii stream.
*
* @return a <code>java.io.InputStream</code> object containing the
* <code>CLOB</code> data
* @return a {@code java.io.InputStream} object containing the
* {@code CLOB} data
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code CLOB} value
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #setAsciiStream
* @since 1.2
*/
@ -127,38 +127,38 @@ public interface Clob {
/**
* Retrieves the character position at which the specified substring
* <code>searchstr</code> appears in the SQL <code>CLOB</code> value
* represented by this <code>Clob</code> object. The search
* begins at position <code>start</code>.
* {@code searchstr} appears in the SQL {@code CLOB} value
* represented by this {@code Clob} object. The search
* begins at position {@code start}.
*
* @param searchstr the substring for which to search
* @param start the position at which to begin searching; the first position
* is 1
* @param start the position at which to begin searching;
* the first position is 1
* @return the position at which the substring appears or -1 if it is not
* present; the first position is 1
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code CLOB} value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.2
*/
long position(String searchstr, long start) throws SQLException;
/**
* Retrieves the character position at which the specified
* <code>Clob</code> object <code>searchstr</code> appears in this
* <code>Clob</code> object. The search begins at position
* <code>start</code>.
* {@code Clob} object {@code searchstr} appears in this
* {@code Clob} object. The search begins at position
* {@code start}.
*
* @param searchstr the <code>Clob</code> object for which to search
* @param searchstr the {@code Clob} object for which to search
* @param start the position at which to begin searching; the first
* position is 1
* @return the position at which the <code>Clob</code> object appears
* or -1 if it is not present; the first position is 1
* @return the position at which the {@code Clob} object appears
* or -1 if it is not present; the first position is 1
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value or if start is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code CLOB} value or if start is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.2
*/
long position(Clob searchstr, long start) throws SQLException;
@ -166,90 +166,91 @@ public interface Clob {
//---------------------------- jdbc 3.0 -----------------------------------
/**
* Writes the given Java <code>String</code> to the <code>CLOB</code>
* value that this <code>Clob</code> object designates at the position
* <code>pos</code>. The string will overwrite the existing characters
* in the <code>Clob</code> object starting at the position
* <code>pos</code>. If the end of the <code>Clob</code> value is reached
* while writing the given string, then the length of the <code>Clob</code>
* Writes the given Java {@code String} to the {@code CLOB}
* value that this {@code Clob} object designates at the position
* {@code pos}. The string will overwrite the existing characters
* in the {@code Clob} object starting at the position
* {@code pos}. If the end of the {@code Clob} value is reached
* while writing the given string, then the length of the {@code Clob}
* value will be increased to accommodate the extra characters.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>CLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code CLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param pos the position at which to start writing to the <code>CLOB</code>
* value that this <code>Clob</code> object represents;
* The first position is 1
* @param str the string to be written to the <code>CLOB</code>
* value that this <code>Clob</code> designates
* @param pos the position at which to start writing to the {@code CLOB}
* value that this {@code Clob} object represents;
* the first position is 1.
* @param str the string to be written to the {@code CLOB}
* value that this {@code Clob} designates
* @return the number of characters written
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value or if pos is less than 1
* {@code CLOB} value or if pos is less than 1
*
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.4
*/
int setString(long pos, String str) throws SQLException;
/**
* Writes <code>len</code> characters of <code>str</code>, starting
* at character <code>offset</code>, to the <code>CLOB</code> value
* that this <code>Clob</code> represents. The string will overwrite the existing characters
* in the <code>Clob</code> object starting at the position
* <code>pos</code>. If the end of the <code>Clob</code> value is reached
* while writing the given string, then the length of the <code>Clob</code>
* Writes {@code len} characters of {@code str}, starting
* at character {@code offset}, to the {@code CLOB} value
* that this {@code Clob} represents.
* The string will overwrite the existing characters
* in the {@code Clob} object starting at the position
* {@code pos}. If the end of the {@code Clob} value is reached
* while writing the given string, then the length of the {@code Clob}
* value will be increased to accommodate the extra characters.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>CLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code CLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param pos the position at which to start writing to this
* <code>CLOB</code> object; The first position is 1
* @param str the string to be written to the <code>CLOB</code>
* value that this <code>Clob</code> object represents
* @param offset the offset into <code>str</code> to start reading
* {@code CLOB} object; The first position is 1
* @param str the string to be written to the {@code CLOB}
* value that this {@code Clob} object represents
* @param offset the offset into {@code str} to start reading
* the characters to be written
* @param len the number of characters to be written
* @return the number of characters written
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value or if pos is less than 1
* {@code CLOB} value or if pos is less than 1
*
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.4
*/
int setString(long pos, String str, int offset, int len) throws SQLException;
/**
* Retrieves a stream to be used to write Ascii characters to the
* <code>CLOB</code> value that this <code>Clob</code> object represents,
* starting at position <code>pos</code>. Characters written to the stream
* {@code CLOB} value that this {@code Clob} object represents,
* starting at position {@code pos}. Characters written to the stream
* will overwrite the existing characters
* in the <code>Clob</code> object starting at the position
* <code>pos</code>. If the end of the <code>Clob</code> value is reached
* while writing characters to the stream, then the length of the <code>Clob</code>
* in the {@code Clob} object starting at the position
* {@code pos}. If the end of the {@code Clob} value is reached
* while writing characters to the stream, then the length of the {@code Clob}
* value will be increased to accommodate the extra characters.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>CLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code CLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param pos the position at which to start writing to this
* <code>CLOB</code> object; The first position is 1
* {@code CLOB} object; The first position is 1
* @return the stream to which ASCII encoded characters can be written
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code CLOB} value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #getAsciiStream
*
* @since 1.4
@ -258,28 +259,28 @@ public interface Clob {
/**
* Retrieves a stream to be used to write a stream of Unicode characters
* to the <code>CLOB</code> value that this <code>Clob</code> object
* represents, at position <code>pos</code>. Characters written to the stream
* to the {@code CLOB} value that this {@code Clob} object
* represents, at position {@code pos}. Characters written to the stream
* will overwrite the existing characters
* in the <code>Clob</code> object starting at the position
* <code>pos</code>. If the end of the <code>Clob</code> value is reached
* while writing characters to the stream, then the length of the <code>Clob</code>
* in the {@code Clob} object starting at the position
* {@code pos}. If the end of the {@code Clob} value is reached
* while writing characters to the stream, then the length of the {@code Clob}
* value will be increased to accommodate the extra characters.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>CLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code CLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param pos the position at which to start writing to the
* <code>CLOB</code> value; The first position is 1
* {@code CLOB} value; The first position is 1
*
* @return a stream to which Unicode encoded characters can be written
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* {@code CLOB} value or if pos is less than 1
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @see #getCharacterStream
*
* @since 1.4
@ -287,60 +288,64 @@ public interface Clob {
java.io.Writer setCharacterStream(long pos) throws SQLException;
/**
* Truncates the <code>CLOB</code> value that this <code>Clob</code>
* designates to have a length of <code>len</code>
* Truncates the {@code CLOB} value that this {@code Clob}
* designates to have a length of {@code len}
* characters.
* <p>
* <b>Note:</b> If the value specified for <code>pos</code>
* is greater then the length+1 of the <code>CLOB</code> value then the
* behavior is undefined. Some JDBC drivers may throw a
* <code>SQLException</code> while other drivers may support this
* <b>Note:</b> If the value specified for {@code pos}
* is greater than the length+1 of the {@code CLOB} value then the
* behavior is undefined. Some JDBC drivers may throw an
* {@code SQLException} while other drivers may support this
* operation.
*
* @param len the length, in characters, to which the <code>CLOB</code> value
* @param len the length, in characters, to which the {@code CLOB} value
* should be truncated
* @exception SQLException if there is an error accessing the
* <code>CLOB</code> value or if len is less than 0
* {@code CLOB} value or if len is less than 0
*
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.4
*/
void truncate(long len) throws SQLException;
/**
* This method releases the resources that the <code>Clob</code> object
* holds. The object is invalid once the <code>free</code> method
* This method releases the resources that the {@code Clob} object
* holds. The object is invalid once the {@code free} method
* is called.
* <p>
* After <code>free</code> has been called, any attempt to invoke a
* method other than <code>free</code> will result in a <code>SQLException</code>
* being thrown. If <code>free</code> is called multiple times, the subsequent
* calls to <code>free</code> are treated as a no-op.
* After {@code free} has been called, any attempt to invoke a
* method other than {@code free} will result in a {@code SQLException}
* being thrown. If {@code free} is called multiple times, the subsequent
* calls to {@code free} are treated as a no-op.
*
* @throws SQLException if an error occurs releasing
* the Clob's resources
* the Clob's resources
*
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.6
*/
void free() throws SQLException;
/**
* Returns a <code>Reader</code> object that contains a partial <code>Clob</code> value, starting
* with the character specified by pos, which is length characters in length.
* Returns a {@code Reader} object that contains
* a partial {@code Clob} value, starting with the character
* specified by pos, which is length characters in length.
*
* @param pos the offset to the first character of the partial value to
* be retrieved. The first character in the Clob is at position 1.
* @param length the length in characters of the partial value to be retrieved.
* @return <code>Reader</code> through which the partial <code>Clob</code> value can be read.
* @throws SQLException if pos is less than 1 or if pos is greater than the number of
* characters in the <code>Clob</code> or if pos + length is greater than the number of
* characters in the <code>Clob</code>
* @return {@code Reader} through which
* the partial {@code Clob} value can be read.
* @throws SQLException if pos is less than 1;
* or if pos is greater than the number of characters
* in the {@code Clob};
* or if pos + length is greater than the number of
* characters in the {@code Clob}
*
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @exception SQLFeatureNotSupportedException if the JDBC driver
* does not support this method
* @since 1.6
*/
Reader getCharacterStream(long pos, long length) throws SQLException;

View File

@ -35,7 +35,7 @@ manager to enlist and delist resource objects (supplied by the
resource manager driver) in JTA transactions. The driver vendor
for a specific resource manager provides the implementation of
this API.
<p>
@since 1.4
</body>
</html>

View File

@ -30,7 +30,7 @@ questions.
<body bgcolor="white">
Contains three exceptions thrown by the ORB machinery during unmarshalling.
<p>
@since 1.3
</body>
</html>

View File

@ -31,7 +31,7 @@ package com.sun.tools.attach;
* VirtualMachine#attach VirtalMachine.attach} to attach to a target virtual
* machine.
* This permission is also checked when an {@link
* com.sun.tools.attach.spi.AttachProvider AttachProvider} is created. </p>
* com.sun.tools.attach.spi.AttachProvider AttachProvider} is created.
*
* <p> An <code>AttachPermission</code> object contains a name (also referred
* to as a "target name") but no actions list; you either have the
@ -39,7 +39,7 @@ package com.sun.tools.attach;
* The following table provides a summary description of what the
* permission allows, and discusses the risks of granting code the
* permission.
* <P>
*
* <table border=1 cellpadding=5 summary="Table shows permission
* target name, what the permission allows, and associated risks">
* <tr>

View File

@ -173,12 +173,12 @@ public abstract class HttpExchange {
* <p>
* This method must be called prior to calling {@link #getResponseBody()}.
* @param rCode the response code to send
* @param responseLength if > 0, specifies a fixed response body length
* and that exact number of bytes must be written
* @param responseLength if {@literal > 0}, specifies a fixed response
* body length and that exact number of bytes must be written
* to the stream acquired from getResponseBody(), or else
* if equal to 0, then chunked encoding is used,
* and an arbitrary number of bytes may be written.
* if <= -1, then no response body length is specified and
* if {@literal <= -1}, then no response body length is specified and
* no response body may be written.
* @see HttpExchange#getResponseBody()
*/

View File

@ -39,7 +39,6 @@ import javax.swing.event.SwingPropertyChangeSupport;
* {@link ConnectionState#DISCONNECTED DISCONNECTED}.
* The {@code JConsoleContext} instance will be the source for
* any generated events.
* <p>
*
* @since 1.6
*/