提交 8ac23f95 authored 作者: noelgrandin's avatar noelgrandin

javadoc updates: there is no need to explicitly document thrown exception unless…

javadoc updates: there is no need to explicitly document thrown exception unless it provides some extra commentary
上级 02b57fc3
......@@ -79,15 +79,11 @@ public interface Trigger {
* This method is called when the database is closed.
* If the method throws an exception, it will be logged, but
* closing the database will continue.
*
* @throws SQLException
*/
void close() throws SQLException;
/**
* This method is called when the trigger is dropped.
*
* @throws SQLException
*/
void remove() throws SQLException;
......
......@@ -46,7 +46,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* Returns the length.
*
* @return the length
* @throws SQLException
*/
@Override
public long length() throws SQLException {
......@@ -69,7 +68,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* [Not supported] Truncates the object.
*
* @param len the new length
* @throws SQLException
*/
@Override
public void truncate(long len) throws SQLException {
......@@ -82,7 +80,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* @param pos the index, the first byte is at position 1
* @param length the number of bytes
* @return the bytes, at most length bytes
* @throws SQLException
*/
@Override
public byte[] getBytes(long pos, int length) throws SQLException {
......@@ -139,7 +136,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* @param offset the bytes offset
* @param len the number of bytes to write
* @return how many bytes have been written
* @throws SQLException
*/
@Override
public int setBytes(long pos, byte[] bytes, int offset, int len) throws SQLException {
......@@ -150,7 +146,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* Returns the input stream.
*
* @return the input stream
* @throws SQLException
*/
@Override
public InputStream getBinaryStream() throws SQLException {
......@@ -218,7 +213,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* @param pattern the pattern to search
* @param start the index, the first byte is at position 1
* @return the position (first byte is at position 1), or -1 for not found
* @throws SQLException
*/
@Override
public long position(byte[] pattern, long start) throws SQLException {
......@@ -274,7 +268,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* @param blobPattern the pattern to search
* @param start the index, the first byte is at position 1
* @return the position (first byte is at position 1), or -1 for not found
* @throws SQLException
*/
@Override
public long position(Blob blobPattern, long start) throws SQLException {
......@@ -319,7 +312,6 @@ public class JdbcBlob extends TraceObject implements Blob {
* @param pos where to start reading
* @param length the number of bytes that will be read
* @return the input stream to read
* @throws SQLException
*/
@Override
public InputStream getBinaryStream(long pos, long length) throws SQLException {
......
......@@ -69,8 +69,6 @@ public class JdbcXAConnection extends TraceObject implements XAConnection, XARes
/**
* Close the physical connection.
* This method is usually called by the connection pool.
*
* @throws SQLException
*/
@Override
public void close() throws SQLException {
......@@ -188,7 +186,6 @@ public class JdbcXAConnection extends TraceObject implements XAConnection, XARes
* @param flag TMSTARTRSCAN, TMENDRSCAN, or TMNOFLAGS. If no other flags are set,
* TMNOFLAGS must be used.
* @return zero or more Xid objects
* @throws XAException
*/
@Override
public Xid[] recover(int flag) throws XAException {
......@@ -226,7 +223,6 @@ public class JdbcXAConnection extends TraceObject implements XAConnection, XARes
*
* @param xid the transaction id
* @return XA_OK
* @throws XAException
*/
@Override
public int prepare(Xid xid) throws XAException {
......@@ -268,7 +264,6 @@ public class JdbcXAConnection extends TraceObject implements XAConnection, XARes
* Roll back a transaction.
*
* @param xid the transaction id
* @throws XAException
*/
@Override
public void rollback(Xid xid) throws XAException {
......@@ -299,7 +294,6 @@ public class JdbcXAConnection extends TraceObject implements XAConnection, XARes
*
* @param xid the transaction id
* @param flags TMSUCCESS, TMFAIL, or TMSUSPEND
* @throws XAException
*/
@Override
public void end(Xid xid, int flags) throws XAException {
......@@ -321,7 +315,6 @@ public class JdbcXAConnection extends TraceObject implements XAConnection, XARes
*
* @param xid the transaction id
* @param flags TMNOFLAGS, TMJOIN, or TMRESUME
* @throws XAException
*/
@Override
public void start(Xid xid, int flags) throws XAException {
......@@ -352,7 +345,6 @@ public class JdbcXAConnection extends TraceObject implements XAConnection, XARes
*
* @param xid the transaction id
* @param onePhase use a one-phase protocol if true
* @throws XAException
*/
@Override
public void commit(Xid xid, boolean onePhase) throws XAException {
......
......@@ -756,7 +756,7 @@ public class DataUtils {
*
* @param len the number of bytes requested
* @return the byte array
* @throws OutOfMemoryError
* @throws OutOfMemoryError if the allocation was too large
*/
public static byte[] newBytes(int len) {
if (len == 0) {
......
......@@ -120,7 +120,6 @@ public class ChangeFileEncryption extends Tool {
* @param decryptPassword the decryption password as a char array
* @param encryptPassword the encryption password as a char array
* @param quiet don't print progress information
* @throws SQLException
*/
public static void execute(String dir, String db, String cipher,
char[] decryptPassword, char[] encryptPassword, boolean quiet) throws SQLException {
......
......@@ -107,10 +107,6 @@ public class ConvertTraceFile extends Tool {
/**
* Converts a trace file to a Java class file and a script file.
*
* @param traceFileName
* @param javaClassName
* @throws IOException
*/
private void convertFile(String traceFileName, String javaClassName, String script) throws IOException {
LineNumberReader reader = new LineNumberReader(IOUtils.getBufferedReader(
......
......@@ -93,7 +93,6 @@ public class CreateCluster extends Tool {
* @param user the user name
* @param password the password
* @param serverList the server list
* @throws SQLException
*/
public void execute(String urlSource, String urlTarget,
String user, String password, String serverList) throws SQLException {
......
......@@ -130,7 +130,6 @@ public class Csv implements SimpleRowSource {
* @param writer the writer
* @param rs the result set
* @return the number of rows written
* @throws SQLException
*/
public int write(Writer writer, ResultSet rs) throws SQLException {
this.output = writer;
......@@ -153,7 +152,6 @@ public class Csv implements SimpleRowSource {
* @param charset the charset or null to use the system default charset
* (see system property file.encoding)
* @return the number of rows written
* @throws SQLException
*/
public int write(String outputFileName, ResultSet rs, String charset) throws SQLException {
init(outputFileName, charset);
......@@ -174,7 +172,6 @@ public class Csv implements SimpleRowSource {
* @param charset the charset or null to use the system default charset
* (see system property file.encoding)
* @return the number of rows written
* @throws SQLException
*/
public int write(Connection conn, String outputFileName, String sql, String charset) throws SQLException {
Statement stat = conn.createStatement();
......@@ -201,7 +198,6 @@ public class Csv implements SimpleRowSource {
* @param charset the charset or null to use the system default charset
* (see system property file.encoding)
* @return the result set
* @throws SQLException
*/
public ResultSet read(String inputFileName, String[] colNames, String charset) throws SQLException {
init(inputFileName, charset);
......@@ -220,7 +216,6 @@ public class Csv implements SimpleRowSource {
* @param reader the reader
* @param colNames or null if the column names should be read from the CSV file
* @return the result set
* @throws IOException
*/
public ResultSet read(Reader reader, String[] colNames) throws IOException {
init(null, null);
......
......@@ -18,7 +18,6 @@ public interface SimpleRowSource {
* Get the next row. Must return null if no more rows are available.
*
* @return the row or null
* @throws SQLException
*/
Object[] readRow() throws SQLException;
......
......@@ -178,8 +178,6 @@ public abstract class TriggerAdapter implements Trigger {
* If the method throws an exception, it will be logged, but
* closing the database will continue.
* The default implementation does nothing.
*
* @throws SQLException
*/
@Override
public void remove() throws SQLException {
......@@ -189,8 +187,6 @@ public abstract class TriggerAdapter implements Trigger {
/**
* This method is called when the trigger is dropped.
* The default implementation does nothing.
*
* @throws SQLException
*/
@Override
public void close() throws SQLException {
......
......@@ -152,9 +152,6 @@ public class TableInspector {
* the model between databases), and if to automatically trim strings for
* those that have a maximum length.
* <p>
* @param packageName
* @param annotateSchema
* @param trimStrings
* @return a complete model (class definition) for this table as a string
*/
String generateModel(String packageName, boolean annotateSchema,
......@@ -255,7 +252,6 @@ public class TableInspector {
/**
* Generates the specified index annotation.
* @param ap
*/
void generateIndexAnnotations(AnnotationBuilder ap, String parameter, IndexType type) {
List<IndexInspector> list = getIndexes(type);
......@@ -367,8 +363,8 @@ public class TableInspector {
* warnings, and errors about the model. The caller may choose to have
* validate throw an exception on any validation ERROR.
*
* @param <T>
* @param def
* @param <T> the table type
* @param def the table definition
* @param throwError whether or not to throw an exception if an error was
* found
* @return a list if validation remarks
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论