You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by rh...@apache.org on 2018/06/30 18:10:32 UTC
svn commit: r1834756 - in /db/derby/code/trunk/java:
org.apache.derby.client/org/apache/derby/client/
org.apache.derby.client/org/apache/derby/client/am/
org.apache.derby.client/org/apache/derby/client/am/stmtcache/
org.apache.derby.commons/org/apache/...
Author: rhillegas
Date: Sat Jun 30 18:10:32 2018
New Revision: 1834756
URL: http://svn.apache.org/viewvc?rev=1834756&view=rev
Log:
DERBY-6945: Cleanup some header comments so that module-aware javadoc can be generated from the product codeline; commit derby-6945-41-ac-cleanupProductJavadoc.diff.
Removed:
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/sql/GenericClassInfo.java
Modified:
db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceFactory.java
db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java
db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java
db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java
db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/stmtcache/package.html
db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java
db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/EngineType.java
db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/Property.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/FailedProperties40.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/conn/LanguageConnectionContext.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/BooleanDataValue.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/sql/execute/rts/RealSetOpResultSetStatistics.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/store/access/btree/index/package.html
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/Version.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/VersionMBean.java
Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceFactory.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/ClientDataSourceFactory.java Sat Jun 30 18:10:32 2018
@@ -52,9 +52,9 @@ import javax.naming.spi.ObjectFactory;
* object is retrieved from JNDI. A JDBC driver vendor should provide an object
* factory as part of their JDBC 2.0 product.
*
- * @see org.apache.derby.jdbc.ClientDataSource
- * @see org.apache.derby.jdbc.ClientConnectionPoolDataSource
- * @see org.apache.derby.jdbc.ClientXADataSource
+ * See org.apache.derby.jdbc.ClientDataSource
+ * See org.apache.derby.jdbc.ClientConnectionPoolDataSource
+ * See org.apache.derby.jdbc.ClientXADataSource
*/
public class ClientDataSourceFactory implements ObjectFactory {
Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/ClientDatabaseMetaData.java Sat Jun 30 18:10:32 2018
@@ -1169,6 +1169,9 @@ public abstract class ClientDatabaseMeta
* (TransactionController,UUID)</code> so it will become available
* in newly created databases and after <b>hard</b> upgrade.
*
+ * See org.apache.derby.impl.sql.catalog.DataDictionaryImpl#create_10_2_system_procedures(TransactionController,java.util.HashSet,UUID)
+ * See org.apache.derby.impl.jdbc.EmbedDatabaseMetaData#getFunctions(String,String,String)
+ *
* @param catalog limit search to this catalog
* @param schemaPattern limit search to schemas matching this pattern
* @param functionNamePattern limit search to functions matching this
@@ -1176,8 +1179,6 @@ public abstract class ClientDatabaseMeta
* @return a <code>ResultSet</code> listing the fucntions
* @exception SQLException if a database error occurs
* @see #getFunctionsX(String, String, String)
- * @see org.apache.derby.impl.sql.catalog.DataDictionaryImpl#create_10_2_system_procedures(TransactionController,java.util.HashSet,UUID)
- * @see org.apache.derby.impl.jdbc.EmbedDatabaseMetaData#getFunctions(String,String,String)
*/
public ResultSet getFunctions(String catalog,
@@ -1245,6 +1246,9 @@ public abstract class ClientDatabaseMeta
* (TransactionController,UUID)</code> so it will become available
* in newly created databases and after <b>hard</b> upgrade.
*
+ * See org.apache.derby.impl.sql.catalog.DataDictionaryImpl#create_10_2_system_procedures(TransactionController,java.util.HashSet,UUID)
+ * See org.apache.derby.impl.jdbc.EmbedDatabaseMetaData#getFunctions(String,String,String)
+ *
* @param catalog limit search to this catalog
* @param schemaPattern limit search to schemas matching this pattern
* @param functionNamePattern limit search to functions matching this
@@ -1252,8 +1256,6 @@ public abstract class ClientDatabaseMeta
* @return a <code>ResultSet</code> listing the fucntions
* @exception SQLException if a database error occurs
* @see #getFunctionColumnsX(String, String, String,String)
- * @see org.apache.derby.impl.sql.catalog.DataDictionaryImpl#create_10_2_system_procedures(TransactionController,java.util.HashSet,UUID)
- * @see org.apache.derby.impl.jdbc.EmbedDatabaseMetaData#getFunctions(String,String,String)
*/
public ResultSet
getFunctionColumns(String catalog,
Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/FailedProperties40.java Sat Jun 30 18:10:32 2018
@@ -34,8 +34,8 @@ import java.sql.ClientInfoStatus;
* convenient access to data that is needed when constructing
* those exceptions. Should be kept in sync with its embedded
* counter part.
- * @see java.sql.SQLClientInfoException
- * @see org.apache.derby.iapi.jdbc.FailedProperties40
+ * See java.sql.SQLClientInfoException
+ * See org.apache.derby.iapi.jdbc.FailedProperties40
*/
public class FailedProperties40 {
private final HashMap<String,ClientInfoStatus> failedProps_ =
Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/Sqlca.java Sat Jun 30 18:10:32 2018
@@ -118,7 +118,7 @@ public abstract class Sqlca {
* the error code is {@code -(sqlCode+1)}.</li>
* </ul>
*
- * @see org.apache.derby.impl.drda.DRDAConnThread#getSqlCode(java.sql.SQLException)
+ * See org.apache.derby.impl.drda.DRDAConnThread#getSqlCode(java.sql.SQLException)
*
* @return the error code
*/
Modified: db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/stmtcache/package.html
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/stmtcache/package.html?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/stmtcache/package.html (original)
+++ db/derby/code/trunk/java/org.apache.derby.client/org/apache/derby/client/am/stmtcache/package.html Sat Jun 30 18:10:32 2018
@@ -131,12 +131,9 @@ pc.close();
<p>Most important classes interacting with the statement cache
(directly or indirectly):</p>
<ul>
- <li>{@link org.apache.derby.client.am.StatementCacheInteractor}
- </li>
- <li>{@link org.apache.derby.client.am.CachingLogicalConnection}
- </li>
- <li>{@link org.apache.derby.client.am.LogicalStatementEntity}
- </li>
+ <li>org.apache.derby.client.am.StatementCacheInteractor</li>
+ <li>org.apache.derby.client.am.CachingLogicalConnection</li>
+ <li>org.apache.derby.client.am.LogicalStatementEntity</li>
</ul>
</body>
</html>
Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/error/StandardException.java Sat Jun 30 18:10:32 2018
@@ -378,12 +378,12 @@ public class StandardException extends E
* Unpack the exception, looking for a StandardException, which carries
* the Derby messageID and arguments.
*
+ * See org.apache.derby.impl.jdbc.SQLExceptionFactory
+ * See org.apache.derby.impl.jdbc.Util
+ *
* @param se A SQLException
*
* @return a Derby exception wrapping the contents of the SQLException
- *
- * @see org.apache.derby.impl.jdbc.SQLExceptionFactory
- * @see org.apache.derby.impl.jdbc.Util
*/
public static StandardException getArgumentFerry(SQLException se)
{
Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/EngineType.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/EngineType.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/EngineType.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/EngineType.java Sat Jun 30 18:10:32 2018
@@ -29,9 +29,9 @@ package org.apache.derby.shared.common.r
* of its engine type and then use that in a decision
* as to if it is suitable.
*
- * @see org.apache.derby.iapi.services.monitor.ModuleSupportable
- * @see org.apache.derby.iapi.services.monitor.Monitor#isDesiredType(Properties, int)
- * @see org.apache.derby.iapi.services.monitor.Monitor#getEngineType(Properties)
+ * See org.apache.derby.iapi.services.monitor.ModuleSupportable
+ * See org.apache.derby.iapi.services.monitor.Monitor#isDesiredType(Properties, int)
+ * See org.apache.derby.iapi.services.monitor.Monitor#getEngineType(Properties)
*
*/
public interface EngineType {
Modified: db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/Property.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/Property.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/Property.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.commons/org/apache/derby/shared/common/reference/Property.java Sat Jun 30 18:10:32 2018
@@ -641,8 +641,8 @@ public interface Property {
*
* A new subsubprotocol can be defined by specifying the class that handles storage for the
* subsubprotocol by implementing the
- * {@link org.apache.derby.io.StorageFactory StorageFactory} or
- * {@link org.apache.derby.io.WritableStorageFactory WritableStorageFactory} interface. This
+ * org.apache.derby.io.StorageFactory StorageFactory or
+ * org.apache.derby.io.WritableStorageFactory WritableStorageFactory interface. This
* is done using a property named db2j.subsubprotocol.<i>xxx</i> where <i>xxx</i> is the subsubprotocol name.
* Subsubprotocol names are case sensitive and must be at least 3 characters in length.
*<p>
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/FailedProperties40.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/FailedProperties40.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/FailedProperties40.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/FailedProperties40.java Sat Jun 30 18:10:32 2018
@@ -35,7 +35,6 @@ import java.sql.ClientInfoStatus;
* be kept in sync with its client side counter part
* (org.apache.derby.client.am.FailedProperties40).
* @see java.sql.SQLClientInfoException
- * @see org.apache.derby.client.am.FailedProperties40
*/
public class FailedProperties40 {
private final HashMap<String,ClientInfoStatus> failedProps_ =
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/conn/LanguageConnectionContext.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/conn/LanguageConnectionContext.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/conn/LanguageConnectionContext.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/conn/LanguageConnectionContext.java Sat Jun 30 18:10:32 2018
@@ -213,11 +213,10 @@ public interface LanguageConnectionConte
public void addDeclaredGlobalTempTable(TableDescriptor td) throws StandardException;
/**
- * Drop (mark the declared global temporary table for dropping) from the list of temporary tables known by this connection.
+ * Drop (mark the declared global temporary table for dropping) from the list of temporary tables known by this connection. Used by org.apache.derby.impl.sql.conn.TempTableInfo.
+ *
* @param tableName look for this table name in the saved list and drop it if found
* @return true if dropped the temporary table. False if no such temporary table exists.
- *
- * @see org.apache.derby.impl.sql.conn.TempTableInfo
*/
public boolean dropDeclaredGlobalTempTable(String tableName);
@@ -1111,13 +1110,12 @@ public interface LanguageConnectionConte
* procedure or function that can contain SQL is invoked, cf. SQL 2003
* section 4.27.3, since this gives rise to a nested connection.
* <p>
- * Called from generated code, see
- * {@link org.apache.derby.impl.sql.compile.StaticMethodCallNode#generatePushNestedSessionContext}.
+ * Called from generated code, at
+ * org.apache.derby.impl.sql.compile.StaticMethodCallNode#generatePushNestedSessionContext.
* <p>
* The new SQL session context is also set in the current statement
* context (of the invocation).
*
- * @see org.apache.derby.impl.sql.compile.StaticMethodCallNode#generatePushNestedSessionContext
* @see StatementContext#getSQLSessionContext
* @see #setupSubStatementSessionContext
*
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/BooleanDataValue.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/BooleanDataValue.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/BooleanDataValue.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/BooleanDataValue.java Sat Jun 30 18:10:32 2018
@@ -107,7 +107,7 @@ public interface BooleanDataValue extend
/**
* If this value is false and we have a deferred constraint, remember the
* violation and proceed, else throw. See also
- * {@link org.apache.derby.impl.sql.compile.AndNoShortCircuitNode}.
+ * org.apache.derby.impl.sql.compile.AndNoShortCircuitNode.
*
* @param SQLState The SQLState of the exception to throw if
* this SQLBoolean is false.
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/sql/execute/rts/RealSetOpResultSetStatistics.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/sql/execute/rts/RealSetOpResultSetStatistics.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/sql/execute/rts/RealSetOpResultSetStatistics.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/sql/execute/rts/RealSetOpResultSetStatistics.java Sat Jun 30 18:10:32 2018
@@ -55,6 +55,8 @@ public class RealSetOpResultSetStatistic
* Constructs a new <code>RealSetOpResultSetStatistics</code> object
* to represent the runtime statistics for <code>SetOpResultSet</code>.
*
+ * See org.apache.derby.impl.sql.execute.SetOpResultSet
+ *
* @param opType set operation type
* @param numOpens number of open
* @param rowsSeen rows seen
@@ -71,8 +73,6 @@ public class RealSetOpResultSetStatistic
* @param optimizerEstimatedCost optimizer estimated cost
* @param leftResultSetStatistics left source runtime statistics
* @param rightResultSetStatistics right source runtime statistics
- *
- * @see org.apache.derby.impl.sql.execute.SetOpResultSet
*/
public RealSetOpResultSetStatistics(
int opType,
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/store/access/btree/index/package.html
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/store/access/btree/index/package.html?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/store/access/btree/index/package.html (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/store/access/btree/index/package.html Sat Jun 30 18:10:32 2018
@@ -23,12 +23,12 @@
<p>
Implements classes used by the language layer to implement
SQL secondary indexes. The classes here extend and use the classes in
-{@link org.apache.derby.impl.store.access.btree} to implement
+org.apache.derby.impl.store.access.btree to implement
a locked btree index.
<p>
The key to understanding the class layout is to understand the public
store interfaces in
-{@link org.apache.derby.iapi.store.access.conglomerate}, which contains
+org.apache.derby.iapi.store.access.conglomerate, which contains
the shared interfaces that must be implemented by all access methods.
Currently Derby implements heap and btree index access methods. Users of
access methods use the same interface no matter what the underlying
@@ -46,7 +46,7 @@ methods.
<p>Isolation level implementation in the B-Tree index is done with data
only locking, i.e., locks on secondary index rows are actually locks on the
data rows that they point to. The specifics of particular isolation levels
-are hidden in various implementations of the {@link org.apache.derby.impl.store.access.btree.BTreeLockingPolicy BTreeLockingPolicy} class.
+are hidden in various implementations of the org.apache.derby.impl.store.access.btree.BTreeLockingPolicy BTreeLockingPolicy class.
The classes which do scans, deletes, and inserts do not have isolation
specific code, instead they make lock calls using BTreeLockingPolicy
interfaces, and then depending on the isolation level one of the implmentations
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/Version.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/Version.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/Version.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/Version.java Sat Jun 30 18:10:32 2018
@@ -33,7 +33,7 @@ import org.apache.derby.shared.common.se
* ProductVersionHolder object. The MBean interface is implemented with
* callbacks to the wrapped object which gives detailed version information.
*
- * @see org.apache.derby.iapi.services.info.ProductVersionHolder
+ * See org.apache.derby.iapi.services.info.ProductVersionHolder
*/
public class Version implements VersionMBean {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/VersionMBean.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/VersionMBean.java?rev=1834756&r1=1834755&r2=1834756&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/VersionMBean.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/VersionMBean.java Sat Jun 30 18:10:32 2018
@@ -44,7 +44,7 @@ package org.apache.derby.mbeans;
* <LI> <code>SystemPermission("engine", "monitor")</code> for version information
* specific to derby.jar
* </UL>
- * @see org.apache.derby.security.SystemPermission
+ * See org.apache.derby.security.SystemPermission
*/
public interface VersionMBean {
// attributes