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/14 23:29:39 UTC
svn commit: r1833569 [1/4] - in
/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby: agg/
authentication/ catalog/ database/ iapi/db/ iapi/jdbc/ iapi/services/cache/
iapi/services/context/ iapi/services/crypto/ iapi/services/daemon/ iapi...
Author: rhillegas
Date: Thu Jun 14 23:29:38 2018
New Revision: 1833569
URL: http://svn.apache.org/viewvc?rev=1833569&view=rev
Log:
DERBY-6945: Cleanup more javadoc warnings; commit derby-6945-39-aa-javadocCleanup.diff.
Removed:
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/ConnectionInfo.java
Modified:
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/agg/Aggregator.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/authentication/SystemPrincipal.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/AliasInfo.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/DefaultInfo.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/GetProcedureColumns.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/IndexDescriptor.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Java5SystemProcedures.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SequencePreallocator.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Statistics.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SystemProcedures.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/TypeDescriptor.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/UUID.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/database/Database.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Database.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Factory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/OptimizerTrace.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/TriggerExecutionContext.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/AuthenticationService.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredCallableStatement.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection42.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnectionControl.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredPreparedStatement.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredStatementControl.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ConnectionContext.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/DRDAServerStarter.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EmbeddedDataSourceInterface.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineConnection.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EnginePreparedStatement.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineResultSet.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/jdbc/InternalDriver.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/JDBCBoot.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ResourceAdapter.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheManager.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/Cacheable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheableFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/ClassSize.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/Context.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextManager.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextService.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactoryBuilder.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherProvider.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/DaemonFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/IndexStatisticsDaemon.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/Serviceable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/diag/Diagnosticable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/AccessibleByteArrayOutputStream.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayInputStream.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayOutputStream.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CompressedNumber.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CounterOutputStream.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/DynamicByteArrayOutputStream.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FileUtil.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableArrayHolder.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableBitSet.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableInstanceGetter.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/InputStreamUtil.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/Limit.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitInputStream.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitReader.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/RegisteredFormatIds.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/StreamStorable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/jmx/ManagementService.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactoryContext.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInfo.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInspector.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedByteCode.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedClass.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedMethod.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/InstanceGetter.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/JarReader.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Latch.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockOwner.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Lockable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/monitor/ModuleControl.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PersistentSet.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PropertyFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PropertyUtil.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/uuid/UUIDFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/Activation.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/LanguageFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/ParameterValueSet.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/PreparedStatement.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/ResultColumnDescriptor.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/ResultDescription.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/ResultSet.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/Row.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/Statement.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/sql/dictionary/DataDictionary.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/dictionary/RoleGrantDescriptor.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/dictionary/SPSDescriptor.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/dictionary/TableDescriptor.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/execute/ExecAggregator.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/sql/execute/ResultSetFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/AccessFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/BackingStoreHashtable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/ColumnOrdering.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/Qualifier.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/RowUtil.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/SpaceInfo.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/StoreCostController.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/StoreCostResult.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/TransactionController.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/conglomerate/ScanManager.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/access/conglomerate/TransactionManager.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/raw/ContainerHandle.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/raw/ContainerLock.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/raw/Loggable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/raw/RawStoreFactory.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/store/raw/Undoable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/RawToBinaryFormatStream.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/Resetable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/types/SQLBinary.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/util/InterruptStatus.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/util/StringUtil.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/jdbc/EmbedResultSet.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/impl/jdbc/TransactionResourceImpl.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/mbeans/JDBCMBean.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/AwareVTI.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/ForeignTableVTI.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/ForwardingVTI.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/IFastPath.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/IQualifyable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/Pushable.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/RestrictedVTI.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/Restriction.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/StringColumnVTI.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/VTIContext.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/VTIEnvironment.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/VTIMetaDataTemplate.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/VTITemplate.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/XmlVTI.java
db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/vti/package.html
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/agg/Aggregator.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/agg/Aggregator.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/agg/Aggregator.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/agg/Aggregator.java Thu Jun 14 23:29:38 2018
@@ -35,7 +35,11 @@ public interface Aggregator<V,R,A extend
/** Initialize the Aggregator */
public void init();
- /** Accumulate the next scalar value */
+ /**
+ * Accumulate the next scalar value
+ *
+ * @param value The new value to accumulate.
+ */
public void accumulate( V value );
/**
@@ -55,10 +59,16 @@ public interface Aggregator<V,R,A extend
* <pre>
* select a, mode( b ) from mode_inputs group by a order by a
* </pre>
+ *
+ * @param otherAggregator The other Aggregator to merge with
*/
public void merge( A otherAggregator );
- /** Return the result scalar value */
+ /**
+ * Return the result scalar value
+ *
+ * @return the result scalar value
+ */
public R terminate();
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/authentication/SystemPrincipal.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/authentication/SystemPrincipal.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/authentication/SystemPrincipal.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/authentication/SystemPrincipal.java Thu Jun 14 23:29:38 2018
@@ -76,11 +76,11 @@ final public class SystemPrincipal imple
* As an alternative approach, class <code>SystemPrincipal</code> could
* implement the non-standard interface
* <code>com.sun.security.auth.PrincipalComparator</code>, which declares
- * a method <code>implies(Subject)<code> that would allow for Principals
+ * a method <code>implies(Subject)</code> that would allow for Principals
* to match Subjects on the basis of normalized Authorization Identifiers.
* But then we'd be relying upon non-standard Security Runtime behaviour.
*
- * @see <a href="http://wiki.apache.org/db-derby/UserIdentifiers">User Names & Authorization Identifiers in Derby</a>
+ * @see <a href="http://wiki.apache.org/db-derby/UserIdentifiers">User Names & Authorization Identifiers in Derby</a>
*/
private final String name;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/AliasInfo.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/AliasInfo.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/AliasInfo.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/AliasInfo.java Thu Jun 14 23:29:38 2018
@@ -79,6 +79,8 @@ public interface AliasInfo
/**
* Return true if this alias is a Table Function.
+ *
+ * @return true if this alias is a Table Function
*/
public boolean isTableFunction();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/DefaultInfo.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/DefaultInfo.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/DefaultInfo.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/DefaultInfo.java Thu Jun 14 23:29:38 2018
@@ -36,6 +36,8 @@ public interface DefaultInfo
/**
* If this default is a generation clause, then return the names of
* other columns in the row which the generation clause references.
+ *
+ * @return the referenced column names
*/
public String[] getReferencedColumnNames();
@@ -55,12 +57,16 @@ public interface DefaultInfo
/**
* Return true if this is the generation clause for a generated column.
+ *
+ * @return true if this is the generation clause for a generated column.
*/
public boolean isGeneratedColumn();
/**
* Return the name of the current schema when the default was created. This
* is filled in for generated columns.
+ *
+ * @return the name of the current schema when the default was created
*/
public String getOriginalCurrentSchema();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/GetProcedureColumns.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/GetProcedureColumns.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/GetProcedureColumns.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/GetProcedureColumns.java Thu Jun 14 23:29:38 2018
@@ -39,12 +39,10 @@ import org.apache.derby.catalog.types.Ro
<P>This class is called from a Query constructed in
java/org.apache.derby.impl.jdbc/metadata.properties:
-<PRE>
-
-
- <P>The VTI will return columns 3-14, an extra column to the specification
+ The VTI will return columns 3-14, an extra column to the specification
METHOD_ID is returned to distinguish between overloaded methods.
-
+ </P>
+
<OL>
<LI><B>PROCEDURE_CAT</B> String => procedure catalog (may be null)
<LI><B>PROCEDURE_SCHEM</B> String => procedure schema (may be null)
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/IndexDescriptor.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/IndexDescriptor.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/IndexDescriptor.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/IndexDescriptor.java Thu Jun 14 23:29:38 2018
@@ -88,11 +88,15 @@ public interface IndexDescriptor
{
/**
* Returns true if the index is unique.
+ *
+ * @return true if the index is unique
*/
boolean isUnique();
/**
* Returns true if the index is duplicate keys only for null key parts.
* This is effective only if isUnique is false.
+ *
+ * @return true if the index is duplicate keys only for null key parts
*/
boolean isUniqueWithDuplicateNulls();
@@ -109,6 +113,8 @@ public interface IndexDescriptor
/**
* Returns true if the index is used to support a deferrable constraint.
+ *
+ * @return true if the index is used to support a deferrable constraint
*/
boolean hasDeferrableChecking();
@@ -119,15 +125,24 @@ public interface IndexDescriptor
* The returned array holds the column positions in the
* base table, so, if entry 2 is the number 4, the second
* column in the index is the fourth column in the table.
+ *
+ * @return an array of column positions in the base table
*/
public int[] baseColumnPositions();
/**
+ * <p>
* Returns the postion of a column.
+ * </p>
* <p>
* Returns the position of a column within the key (1-based).
* 0 means that the column is not in the key. Same as the above
* method, but it uses int instead of Integer.
+ * </p>
+ *
+ * @param heapColumnPosition Position of column in heap row
+ *
+ * @return the position of the column in the key
*/
public int getKeyColumnPosition(int heapColumnPosition);
@@ -141,12 +156,16 @@ public interface IndexDescriptor
* non-ordered columns.
*
* For now, all columns in an index must be ordered.
+ *
+ * @return the number of ordered columns
*/
int numberOfOrderedColumns();
/**
* Returns the type of the index. For now, we only support B-Trees,
* so the value "BTREE" is returned.
+ *
+ * @return the type of the index
*/
String indexType();
@@ -154,12 +173,17 @@ public interface IndexDescriptor
* Returns array of boolean telling asc/desc info for each index
* key column for convenience of using together with baseColumnPositions
* method. Both methods return an array with subscript starting from 0.
+ *
+ * @return array of boolean telling asc/desc info for each index key
*/
public boolean[] isAscending();
/**
* Returns true if the specified column is ascending in the index
* (1-based).
+ *
+ * @param keyColumnPosition Key column number
+ * @return true if the specified column is ascending in the index
*/
boolean isAscending(Integer keyColumnPosition);
@@ -167,6 +191,9 @@ public interface IndexDescriptor
* Returns true if the specified column is descending in the index
* (1-based). In the current release, only ascending columns are
* supported.
+ *
+ * @param keyColumnPosition Key column number
+ * @return true if the specified column is descending in the index
*/
boolean isDescending(Integer keyColumnPosition);
@@ -174,6 +201,8 @@ public interface IndexDescriptor
* set the baseColumnPositions field of the index descriptor. This
* is for updating the field in operations such as "alter table drop
* column" where baseColumnPositions is changed.
+ *
+ * @param baseColumnPositions Positions of base columns
*/
public void setBaseColumnPositions(int[] baseColumnPositions);
@@ -181,6 +210,8 @@ public interface IndexDescriptor
* set the isAscending field of the index descriptor. This
* is for updating the field in operations such as "alter table drop
* column" where isAscending is changed.
+ *
+ * @param isAscending Set the direction of each column in the key
*/
public void setIsAscending(boolean[] isAscending);
@@ -188,6 +219,8 @@ public interface IndexDescriptor
* set the numberOfOrderedColumns field of the index descriptor. This
* is for updating the field in operations such as "alter table drop
* column" where numberOfOrderedColumns is changed.
+ *
+ * @param numberOfOrderedColumns Number of ordered columns
*/
public void setNumberOfOrderedColumns(int numberOfOrderedColumns);
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Java5SystemProcedures.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Java5SystemProcedures.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Java5SystemProcedures.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Java5SystemProcedures.java Thu Jun 14 23:29:38 2018
@@ -88,6 +88,8 @@ public class Java5SystemProcedures
* @param toolName Name of the tool package.
* @param register True if the package should be loaded, false otherwise.
* @param optionalArgs Tool-specific configuration parameters.
+ *
+ * @throws SQLException on error
*/
public static void SYSCS_REGISTER_TOOL
(
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SequencePreallocator.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SequencePreallocator.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SequencePreallocator.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SequencePreallocator.java Thu Jun 14 23:29:38 2018
@@ -59,6 +59,8 @@ public interface SequencePreallocator
*
* @param schemaName Name of schema holding the sequence.
* @param sequenceName Specific name of the sequence.
+ *
+ * @return the size of the next pre-allocated range
*/
public int nextRangeSize
(
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Statistics.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Statistics.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Statistics.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/Statistics.java Thu Jun 14 23:29:38 2018
@@ -23,12 +23,12 @@ package org.apache.derby.catalog;
/**
- <P>
+ <p>
This interface is used in the column SYS.SYSSTATISTICS.STATISTICS. It
encapsulates information collected by the UPDATE STATISTICS command
and is used internally by the Derby optimizer to estimate cost
and selectivity of different query plans.
- <p>
+ </p>
*/
public interface Statistics
@@ -41,6 +41,7 @@ public interface Statistics
long getRowEstimate();
/**
+ * @param predicates The predicates to evaluate
* @return the selectivity for a set of predicates.
*/
double selectivity(Object[] predicates);
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SystemProcedures.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SystemProcedures.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SystemProcedures.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/SystemProcedures.java Thu Jun 14 23:29:38 2018
@@ -223,6 +223,8 @@ public class SystemProcedures {
* the result of getProcedures
* If options contains the string 'DATATYPE='ODBC'', call the ODBC
* version of this procedure.
+ *
+ * @throws SQLException on error
*/
public static void SQLPROCEDURES (String catalogName, String schemaName, String procName,
String options, ResultSet[] rs) throws SQLException
@@ -243,6 +245,8 @@ public class SystemProcedures {
* (not used)
* @param rs output parameter, the resultset object containing
* the result of getFunctions
+ *
+ * @throws SQLException on error
*/
public static void SQLFUNCTIONS(String catalogName,
String schemaName,
@@ -278,6 +282,8 @@ public class SystemProcedures {
* @param tableType SYSIBM.SQLTables TableType varchar(4000))
* @param options SYSIBM.SQLTables Options varchar(4000))
* @param rs output parameter, the resultset object
+ *
+ * @throws SQLException on error
*/
public static void SQLTABLES (String catalogName, String schemaName, String tableName,
String tableType, String options, ResultSet[] rs)
@@ -343,6 +349,8 @@ public class SystemProcedures {
* If options contains the string 'EXPORTEDKEY=1', call getImportedKeys
* If options contains the string 'IMPORTEDKEY=1', call getExportedKeys
* otherwise, call getCrossReference
+ *
+ * @throws SQLException on error
*/
public static void SQLFOREIGNKEYS (String pkCatalogName, String pkSchemaName, String pkTableName,
String fkCatalogName, String fkSchemaName, String fkTableName,
@@ -406,6 +414,8 @@ public class SystemProcedures {
* the result of getProcedureColumns
* If options contains the string 'DATATYPE='ODBC'', call the ODBC
* version of this procedure.
+ *
+ * @throws SQLException on error
*/
public static void SQLPROCEDURECOLS (String catalogName, String schemaName, String procName,
String paramName, String options, ResultSet[] rs)
@@ -433,6 +443,8 @@ public class SystemProcedures {
* varchar(4000))
* @param rs output parameter, the resultset object containing the
* result of getFunctionColumns().
+ *
+ * @throws SQLException on error
*/
public static void SQLFUNCTIONPARAMS(String catalogName,
String schemaName,
@@ -459,6 +471,8 @@ public class SystemProcedures {
* version of this procedure.
* @param rs output parameter, the resultset object containing
* the result of getProcedures
+ *
+ * @throws SQLException on error
*/
public static void SQLCOLUMNS (String catalogName, String schemaName, String tableName,
String columnName, String options, ResultSet[] rs)
@@ -480,6 +494,8 @@ public class SystemProcedures {
* @param options SYSIBM.SQLColPrivileges Options varchar(4000))
* @param rs output parameter, the resultset object containing
* the result of getColumnPrivileges
+ *
+ * @throws SQLException on error
*/
public static void SQLCOLPRIVILEGES (String catalogName, String schemaName, String tableName,
String columnName, String options, ResultSet[] rs)
@@ -497,6 +513,8 @@ public class SystemProcedures {
* @param options SYSIBM.SQLTablePrivileges Options varchar(4000))
* @param rs output parameter, the resultset object containing
* the result of getTablePrivileges
+ *
+ * @throws SQLException on error
*/
public static void SQLTABLEPRIVILEGES (String catalogName, String schemaName, String tableName,
String options, ResultSet[] rs)
@@ -516,6 +534,8 @@ public class SystemProcedures {
* version of this procedure.
* @param rs output parameter, the resultset object containing
* the result of getPrimaryKeys
+ *
+ * @throws SQLException on error
*/
public static void SQLPRIMARYKEYS (String catalogName, String schemaName, String tableName, String options, ResultSet[] rs)
throws SQLException
@@ -532,6 +552,8 @@ public class SystemProcedures {
* version of this procedure.
* @param rs output parameter, the resultset object containing the
* result of getTypeInfo
+ *
+ * @throws SQLException on error
*/
public static void SQLGETTYPEINFO (short dataType, String options, ResultSet[] rs)
throws SQLException
@@ -554,6 +576,8 @@ public class SystemProcedures {
* version of this procedure.
* @param rs output parameter, the resultset object containing
* the result of getIndexInfo
+ *
+ * @throws SQLException on error
*/
public static void SQLSTATISTICS (String catalogName, String schemaName, String tableName,
short unique, short approximate, String options, ResultSet[] rs)
@@ -583,6 +607,8 @@ public class SystemProcedures {
* version of this procedure.
* @param rs output parameter, the resultset object containing
* the result of the DatabaseMetaData call
+ *
+ * @throws SQLException on error
*/
public static void SQLSPECIALCOLUMNS (short colType, String catalogName, String schemaName, String tableName,
short scope, short nullable, String options, ResultSet[] rs)
@@ -616,6 +642,8 @@ public class SystemProcedures {
* @param options SYSIBM.SQLUDTS Options varchar(4000))
* @param rs output parameter, the resultset object containing
* the result of getUDTs, which will be empty
+ *
+ * @throws SQLException on error
*/
public static void SQLUDTS (String catalogName, String schemaPattern, String typeNamePattern,
String udtTypes, String options, ResultSet[] rs)
@@ -654,6 +682,9 @@ public class SystemProcedures {
* Map SYSIBM.METADATA to appropriate EmbedDatabaseMetaData methods
* for now, using the sps in org.apache.derby.iapi.db.jdbc.datadictionary.metadata_net.properties
*
+ *
+ * @param rs A ResultSet
+ * @throws SQLException on error
*/
public static void METADATA (ResultSet[] rs)
throws SQLException
@@ -719,6 +750,7 @@ public class SystemProcedures {
* Will be called as SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY.
*
* @param key The property key.
+ * @return the value mapped to that key
*
* @exception SQLException if a database error occurs
**/
@@ -732,6 +764,12 @@ public class SystemProcedures {
/**
* This method exists so that we can get a property value without performing
* authorization checks.
+ *
+ * @param key The key name
+ * @param authorizationCheck Authorization handle
+ * @return the value mapped to the key
+ *
+ * @throws SQLException on error
*/
private static String getProperty( String key, Securable authorizationCheck )
throws SQLException
@@ -780,7 +818,7 @@ public class SystemProcedures {
* Empty string for index name will raise an
* exception.
*
- * @exception SQLException
+ * @exception SQLException on error
**/
public static void SYSCS_UPDATE_STATISTICS(
String schemaname,
@@ -832,7 +870,7 @@ public class SystemProcedures {
* Empty string for index name will raise an
* exception.
*
- * @exception SQLException
+ * @exception SQLException on error
*/
public static void SYSCS_DROP_STATISTICS(
String schemaname,
@@ -1252,6 +1290,13 @@ public class SystemProcedures {
o defragment requires table level lock in nested user transaction, which
will conflict with user lock on same table in user transaction.
+ @param schema Schema name
+ @param tablename Unqualifed name of table
+ @param purgeRows Whether to purge rows
+ @param defragmentRows Whether to defragment rows
+ @param truncateEnd Whether to truncate
+
+ @throws SQLException on error
**/
public static void SYSCS_INPLACE_COMPRESS_TABLE(
String schema,
@@ -1469,6 +1514,14 @@ public class SystemProcedures {
* IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672) ,
* IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) ,
* IN CODESET VARCHAR(128))
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param fileName Where to dump the table contents
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset The encoding to use
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_EXPORT_TABLE(
@@ -1503,6 +1556,15 @@ public class SystemProcedures {
* IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672) ,
* IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) ,
* IN CODESET VARCHAR(128), IN LOBSFILENAME VARCHAR(32672))
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param fileName Where to dump the table contents
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset The encoding to use
+ * @param lobsFileName Where to dump the large objects
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE(
@@ -1535,6 +1597,13 @@ public class SystemProcedures {
* IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) ,
* IN CODESET VARCHAR(128))
*
+ *
+ * @param selectStatement The query which materializes results
+ * @param fileName Where to dump the table contents
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset The encoding to use
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_EXPORT_QUERY(
@@ -1566,6 +1635,13 @@ public class SystemProcedures {
* IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) ,
* IN CODESET VARCHAR(128), IN LOBSFILENAME VARCHAR(32672))
*
+ * @param selectStatement The query which materializes results
+ * @param fileName Where to dump the table contents
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset The encoding to use
+ * @param lobsFileName Where to dump the large objects
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE(
@@ -1598,6 +1674,15 @@ public class SystemProcedures {
* IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672) ,
* IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) ,
* IN CODESET VARCHAR(128), IN REPLACE SMALLINT)
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param fileName File to read
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset Encoding
+ * @param replace True if the table should be truncated first
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_IMPORT_TABLE(
@@ -1637,6 +1722,17 @@ public class SystemProcedures {
* IN CODESET VARCHAR(128), IN REPLACE SMALLINT
* IN SKIP SMALLINT)
* @exception SQLException if a database error occurs
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param fileName File to read
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset Encoding
+ * @param replace True if the table should be truncated first
+ * @param skip Number of header lines to skip over
+ *
+ * @throws SQLException on error
**/
public static void SYSCS_IMPORT_TABLE_BULK(
String schemaName,
@@ -1688,6 +1784,15 @@ public class SystemProcedures {
* IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672) ,
* IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) ,
* IN CODESET VARCHAR(128), IN REPLACE SMALLINT)
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param fileName File to read
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset Encoding
+ * @param replace True if the table should be truncated first
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE(
@@ -1728,6 +1833,17 @@ public class SystemProcedures {
* IN CHARACTERDELIMITER CHAR(1), IN CODESET VARCHAR(128),
* IN REPLACE SMALLINT)
*
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param insertColumnList Columns to insert
+ * @param columnIndexes Indexes of fields to be imported
+ * @param fileName File to read
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset Encoding
+ * @param replace True if the table should be truncated first
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_IMPORT_DATA(
@@ -1770,6 +1886,17 @@ public class SystemProcedures {
* IN CHARACTERDELIMITER CHAR(1), IN CODESET VARCHAR(128),
* IN REPLACE SMALLINT, IN SKIP SMALLINT)
*
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param insertColumnList Columns to insert
+ * @param columnIndexes Indexes of fields to be imported
+ * @param fileName File to read
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset Encoding
+ * @param replace True if the table should be truncated first
+ * @param skip The number of header lines to skip over
* @exception SQLException if a database error occurs
**/
public static void SYSCS_IMPORT_DATA_BULK(
@@ -1800,14 +1927,6 @@ public class SystemProcedures {
conn.commit();
}
-
-
-
-
-
-
-
-
/**
* Import data from a given file into the specified table columns
* from the specified columns in the file. Data for large object
@@ -1824,6 +1943,16 @@ public class SystemProcedures {
* IN CHARACTERDELIMITER CHAR(1), IN CODESET VARCHAR(128),
* IN REPLACE SMALLINT)
*
+ *
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param insertColumnList Columns to insert
+ * @param columnIndexes Indexes of fields to be imported
+ * @param fileName File to read
+ * @param columnDelimiter Column separator
+ * @param characterDelimiter Quote character
+ * @param codeset Encoding
+ * @param replace True if the table should be truncated first
* @exception SQLException if a database error occurs
**/
public static void SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE(
@@ -1861,6 +1990,11 @@ public class SystemProcedures {
* SYSCS_BULK_INSERT (IN SCHEMANAME VARCHAR(128), IN TABLENAME VARCHAR(128),
* IN VTINAME VARCHAR(32672), IN VTIARG VARCHAR(32672))
*
+ * @param schemaName Name of schema
+ * @param tableName Name of table
+ * @param vtiName VTI which supplies the data
+ * @param vtiArg Its arguments
+ *
* @exception SQLException if a database error occurs
**/
public static void SYSCS_BULK_INSERT(
@@ -1908,6 +2042,8 @@ public class SystemProcedures {
* System procedure called thusly:
*
* SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY()
+ *
+ * @exception SQLException if a database error occurs
**/
public static void SYSCS_RELOAD_SECURITY_POLICY()
throws SQLException
@@ -1955,6 +2091,7 @@ public class SystemProcedures {
/**
* Cotangent function. SYSFUN.COT
* @see <a href="http://mathworld.wolfram.com/HyperbolicFunctions.html">HyperbolicFunctions</a>
+ * @param value The input value
* @return 1 / tan(x)
*/
public static double COT(double value)
@@ -1965,6 +2102,7 @@ public class SystemProcedures {
/**
* Method to return the sign of the given value.
* SYSFUN.SIGN().
+ * @param value The input value
* @return 0, 1 or -1
*/
public static int SIGN(double value)
@@ -1974,6 +2112,7 @@ public class SystemProcedures {
/**
* Pseudo-random number function.
+ * @param seed The input seed
* @return a random number
*/
public static double RAND(int seed)
@@ -1986,7 +2125,7 @@ public class SystemProcedures {
* a specific user - SYSCS_UTIL.SYSCS_SET_USER_ACCESS.
*
* @param userName name of the user in its normal form (not a SQL identifier).
- * @param connectionPermission
+ * @param connectionPermission Permission to set for user
* @throws SQLException Error setting the permission
*/
public static void SYSCS_SET_USER_ACCESS(String userName,
@@ -2045,6 +2184,11 @@ public class SystemProcedures {
/**
* Utility method for SYSCS_SET_USER_ACCESS removes a user from
* one of the access lists, driven by the property name.
+ *
+ * @param listProperty The name of the list
+ * @param userName The user name
+ * @throws SQLException on error
+ * @throws StandardException on error
*/
private static void removeFromAccessList(
String listProperty, String userName)
@@ -2062,7 +2206,10 @@ public class SystemProcedures {
* a specific user - SYSCS_UTIL.SYSCS_GET_USER_ACCESS.
*
* @param userName name of the user in its normal form (not a SQL identifier).
-
+ *
+ * @return the authorization level for the user
+ *
+ * @throws SQLException on error
*/
public static String SYSCS_GET_USER_ACCESS(String userName)
throws SQLException
@@ -2110,6 +2257,8 @@ public class SystemProcedures {
/**
* Invalidate all the stored statements so they will get recompiled when
* executed next time around.
+ *
+ * @throws SQLException on error
*/
public static void SYSCS_INVALIDATE_STORED_STATEMENTS()
throws SQLException
@@ -2133,6 +2282,8 @@ public class SystemProcedures {
* that the cache is empty after this call, as statements may be kept
* by currently executing queries, activations that are about to be garbage
* collected.
+ *
+ * @throws SQLException on error
*/
public static void SYSCS_EMPTY_STATEMENT_CACHE()
throws SQLException
@@ -2158,7 +2309,8 @@ public class SystemProcedures {
/**
* this procedure switches between the different xplain modes
* @param mode either 0 for explain only, or 1 for explain and execute (default)
- * @throws SQLException
+ * @throws SQLException on error
+ * @throws StandardException on error
*/
public static void SYSCS_SET_XPLAIN_MODE(int mode)
throws SQLException, StandardException
@@ -2180,7 +2332,8 @@ public class SystemProcedures {
* are being XPLAIN'd only, not executed.
*
* @return 0 if XPLAIN mode is off, non-zero if on.
- * @throws SQLException
+ * @throws SQLException on error
+ * @throws StandardException on error
*/
public static int SYSCS_GET_XPLAIN_MODE()
throws SQLException, StandardException
@@ -2201,7 +2354,8 @@ public class SystemProcedures {
* textual stream printout. If it is set, statisitcs information is
* stored in that schema in user tables.
* @param schemaName May be an empty string.
- * @throws SQLException
+ * @throws SQLException on error
+ * @throws StandardException on error
*/
public static void SYSCS_SET_XPLAIN_SCHEMA(String schemaName)
throws SQLException, StandardException
@@ -2302,7 +2456,8 @@ public class SystemProcedures {
/**
* This procedure returns the current set XPLAIN_SCHEMA
* @return schema name, may be blank if no schema currently set.
- * @throws SQLException
+ * @throws SQLException on error
+ * @throws StandardException on error
*/
public static String SYSCS_GET_XPLAIN_SCHEMA()
throws SQLException, StandardException
@@ -2322,6 +2477,10 @@ public class SystemProcedures {
/**
* Create a new user.
+ *
+ * @param userName Name of user
+ * @param password corresponding password
+ * @throws SQLException on error
*/
public static void SYSCS_CREATE_USER
(
@@ -2368,6 +2527,13 @@ public class SystemProcedures {
/**
* Create a new user (this entry is called when bootstrapping the credentials of the DBO
* at database creation time.
+ *
+ *
+ * @param userName Name of user
+ * @param password corresponding password
+ * @param tc Transaction
+ *
+ * @throws SQLException on error
*/
public static void addUser
(
@@ -2440,6 +2606,11 @@ public class SystemProcedures {
/**
* Reset a user's password.
+ *
+ * @param userName The user's name
+ * @param password The corresponding password
+ *
+ * @throws SQLException on error
*/
public static void SYSCS_RESET_PASSWORD
(
@@ -2460,6 +2631,11 @@ public class SystemProcedures {
/**
* Reset the password for an already normalized authorization id.
+ *
+ * @param userName The user's name
+ * @param password The corresponding password
+ *
+ * @throws SQLException on error
*/
private static void resetAuthorizationIDPassword
(
@@ -2495,6 +2671,10 @@ public class SystemProcedures {
/**
* Change a user's password.
+ *
+ * @param password The corresponding password
+ *
+ * @throws SQLException on error
*/
public static void SYSCS_MODIFY_PASSWORD
(
@@ -2509,6 +2689,10 @@ public class SystemProcedures {
/**
* Drop a user.
+ *
+ * @param userName The user's name
+ *
+ * @throws SQLException on error
*/
public static void SYSCS_DROP_USER
(
@@ -2553,6 +2737,11 @@ public class SystemProcedures {
/**
* Raise an exception if the user doesn't exist. See commentary on DERBY-5648.
+ *
+ * @param dd The data dictionary
+ * @param userName User to check
+ *
+ * @throws StandardException on error
*/
private static void checkLegalUser( DataDictionary dd, String userName )
throws StandardException
@@ -2566,6 +2755,9 @@ public class SystemProcedures {
/**
* Normalize the user name so that there is only one set of credentials
* for a given authorization id.
+ *
+ * @param userName User name
+ * @throws SQLException on error
*/
private static String normalizeUserName( String userName )
throws SQLException
@@ -2578,7 +2770,7 @@ public class SystemProcedures {
/**
* Return the database name
* @return database name
- * @throws SQLException
+ * @throws SQLException on error
*/
public static String SYSCS_GET_DATABASE_NAME()
throws SQLException
@@ -2595,6 +2787,7 @@ public class SystemProcedures {
*
* @param schemaName The name of the schema holding the sequence.
* @param sequenceName The name of the sequence in that schema.
+ * @return the current value of the sequence generator
*
* @exception SQLException if a database error occurs
**/
@@ -2611,6 +2804,7 @@ public class SystemProcedures {
*
* @param schemaName The name of the schema holding the table.
* @param tableName The name of the table in that schema.
+ * @return the current value of the identity generator
*
* @exception SQLException if a database error occurs
**/
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/TypeDescriptor.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/TypeDescriptor.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/TypeDescriptor.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/TypeDescriptor.java Thu Jun 14 23:29:38 2018
@@ -188,12 +188,16 @@ public interface TypeDescriptor
/**
* Return true if this is a Row Multiset type
- */
+ *
+ * @return true if this is a Row Multiset type
+ */
public boolean isRowMultiSet();
/**
* Return true if this is a user defined type
- */
+ *
+ * @return true if this is a user defined type
+ */
public boolean isUserDefinedType();
/**
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/UUID.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/UUID.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/UUID.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/catalog/UUID.java Thu Jun 14 23:29:38 2018
@@ -48,6 +48,8 @@ public interface UUID extends java.io.Ex
/**
Produce a string representation of this UUID which
is suitable for use as a unique ANSI identifier.
+
+ @return an ANSI identifier
*/
String toANSIidentifier();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/database/Database.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/database/Database.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/database/Database.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/database/Database.java Thu Jun 14 23:29:38 2018
@@ -143,6 +143,8 @@ public interface Database
/**
* Get the Locale for this database.
+ *
+ * @return the Locale for this database.
*/
public Locale getLocale();
@@ -150,6 +152,7 @@ public interface Database
Return the UUID of this database.
@deprecated No longer supported.
+ @return the UUID of this database.
*/
public UUID getId();
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Database.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Database.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Database.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Database.java Thu Jun 14 23:29:38 2018
@@ -69,6 +69,7 @@ public interface Database extends org.ap
* remember the URL that was used to establish the connection,
* so it can implement the DatabaseMetaData.getURL() method.
*
+ * @param cm The context manager
* @param user The UserID of the user getting the connection
* @param drdaID The drda id of the connection (from network server)
* @param dbname The database name
@@ -83,15 +84,20 @@ public interface Database extends org.ap
Push a DbContext onto the provided context stack. This conext will
shut down the database in case of a DatabaseException being
cleaned up.
+
+ @param cm The context manager
*/
public void pushDbContext(ContextManager cm);
/**
Is the database active (open).
+
+ @return true if the database is open
*/
public boolean isActive();
/**
+ * @return the engine type
*/
public int getEngineType();
@@ -120,11 +126,17 @@ public interface Database extends org.ap
*/
public Object getResourceAdapter();
- /** Set the Locale that is returned by this LocaleFinder */
+ /**
+ * Set the Locale that is returned by this LocaleFinder
+ *
+ * @param locale The locale to set
+ */
public void setLocale(Locale locale);
/**
* Return the DataDictionary for this database, set up at boot time.
+ *
+ * @return the DataDictionary for this database, set up at boot time.
*/
public DataDictionary getDataDictionary();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Factory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Factory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Factory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/Factory.java Thu Jun 14 23:29:38 2018
@@ -64,6 +64,8 @@ public class Factory
/**
<P>
Returns the Database object associated with the current connection.
+
+ @return the Database object associated with the current connection
@exception SQLException Not in a connection context.
**/
public static org.apache.derby.database.Database getDatabaseOfConnection()
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/OptimizerTrace.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/OptimizerTrace.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/OptimizerTrace.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/OptimizerTrace.java Thu Jun 14 23:29:38 2018
@@ -68,6 +68,8 @@ public class OptimizerTrace
/**
* Get the current optimizer tracer, if any.
+ *
+ * @return the optimizer tracer
*/
public static OptTrace getOptimizerTracer()
{
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/TriggerExecutionContext.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/TriggerExecutionContext.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/TriggerExecutionContext.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/db/TriggerExecutionContext.java Thu Jun 14 23:29:38 2018
@@ -32,19 +32,19 @@ import org.apache.derby.catalog.UUID;
public interface TriggerExecutionContext
{
/**
- * Return value from </I>getEventType()</I> for
+ * Return value from <I>getEventType()</I> for
* an update trigger.
*/
public static final int UPDATE_EVENT = 1;
/**
- * Return value from </I>getEventType()</I> for
+ * Return value from <I>getEventType()</I> for
* a delete trigger.
*/
public static final int DELETE_EVENT = 2;
/**
- * Return value from </I>getEventType()</I> for
+ * Return value from <I>getEventType()</I> for
* an insert trigger.
*/
public static final int INSERT_EVENT = 3;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/AuthenticationService.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/AuthenticationService.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/AuthenticationService.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/AuthenticationService.java Thu Jun 14 23:29:38 2018
@@ -26,13 +26,15 @@ import java.sql.SQLException;
/**
*
+ * <p>
* The AuthenticationService provides a mechanism for authenticating
* users willing to access JBMS.
+ * </p>
* <p>
* There can be different and user defined authentication schemes, as long
* the expected interface here below is implementing and registered
* as a module when JBMS starts-up.
- * <p>
+ * </p>
*/
public interface AuthenticationService
{
@@ -42,8 +44,10 @@ public interface AuthenticationService
/**
* Authenticate a User inside Derby.
*
+ * @param databaseName The name of the database
* @param info Connection properties info.
- * failure.
+ * @return true if authentication succeeded
+ * @throws SQLException on error
*/
public boolean authenticate(String databaseName, Properties info)
throws SQLException;
@@ -53,6 +57,8 @@ public interface AuthenticationService
* Get the name of the credentials database used to authenticate system-wide operations.
* This returns null for all implementations except NATIVE authentication.
* </p>
+ *
+ * @return the name of the system-wide credentials database
*/
public String getSystemCredentialsDatabaseName();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredCallableStatement.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredCallableStatement.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredCallableStatement.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredCallableStatement.java Thu Jun 14 23:29:38 2018
@@ -638,6 +638,11 @@ public class BrokeredCallableStatement e
}
/**
Create a duplicate CalableStatement to this, including state, from the passed in Connection.
+
+ @param conn The current connection
+ @param oldStatement The old statement
+ @return a new CallableStatement
+ @throws SQLException on error
*/
public CallableStatement createDuplicateStatement(Connection conn, CallableStatement oldStatement) throws SQLException {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection.java Thu Jun 14 23:29:38 2018
@@ -534,6 +534,8 @@ public class BrokeredConnection implemen
/**
Sync up the state of the underlying connection
with the state of this new handle.
+
+ @throws SQLException on error
*/
public void syncState() throws SQLException {
EngineConnection conn = getRealConnection();
@@ -549,6 +551,7 @@ public class BrokeredConnection implemen
if the isolation is set using SQL rather than JDBC. In order to
ensure correct state level information, this method is called
at the start and end of a global transaction.
+ @throws SQLException on error
*/
public void getIsolationUptoDate() throws SQLException {
if (control.isIsolationLevelSetUsingSQLorJDBC()) {
@@ -564,6 +567,7 @@ public class BrokeredConnection implemen
Connection, otherwise set only the Connection related state (ie.
the non-transaction specific state).
+ @throws SQLException on error
*/
public void setState(boolean complete) throws SQLException {
@@ -651,8 +655,8 @@ public class BrokeredConnection implemen
* get the isolation level that is currently being used to prepare
* statements (used for network server)
*
- * @throws SQLException
* @return current prepare isolation level
+ * @throws SQLException on error
* See EmbedConnection#getPrepareIsolation
*/
public final int getPrepareIsolation() throws SQLException
@@ -662,7 +666,7 @@ public class BrokeredConnection implemen
/**
* Add a SQLWarning to this Connection object.
- * @throws SQLException
+ * @throws SQLException on error
*/
public final void addWarning(SQLWarning w) throws SQLException
{
@@ -1026,7 +1030,7 @@ public class BrokeredConnection implemen
* EngineConnection interface, so that the NetworkServer can get at the
* current schema for piggy-backing
* @return the current schema name
- * @throws java.sql.SQLException
+ * @throws java.sql.SQLException on error
*/
public String getCurrentSchemaName() throws SQLException {
try {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection42.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection42.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection42.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnection42.java Thu Jun 14 23:29:38 2018
@@ -25,7 +25,13 @@ import java.sql.SQLException;
public class BrokeredConnection42 extends BrokeredConnection
{
- /** Creates a new instance of BrokeredConnection40 */
+ /**
+ * Creates a new instance of BrokeredConnection40
+ *
+ * @param control The control variable
+ *
+ * @throws SQLException on error
+ */
public BrokeredConnection42(BrokeredConnectionControl control)
throws SQLException {
super(control);
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnectionControl.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnectionControl.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnectionControl.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredConnectionControl.java Thu Jun 14 23:29:38 2018
@@ -33,33 +33,48 @@ public interface BrokeredConnectionContr
{
/**
Return the real JDBC connection for the brokered connection.
+
+ @return the real JDBC connection
+ @throws SQLException on error
*/
public EngineConnection getRealConnection() throws SQLException;
/**
Notify the control class that a SQLException was thrown
during a call on one of the brokered connection's methods.
+
+ @param sqle A sql exception
*/
public void notifyException(SQLException sqle);
/**
Allow control over setting auto commit mode.
+
+ @param autoCommit New auto commit setting
+
+ @throws SQLException on error
*/
public void checkAutoCommit(boolean autoCommit) throws SQLException;
/**
Allow control over creating a Savepoint (JDBC 3.0)
+
+ @throws SQLException on error
*/
public void checkSavepoint() throws SQLException;
/**
Allow control over calling rollback.
+
+ @throws SQLException on error
*/
public void checkRollback() throws SQLException;
/**
Allow control over calling commit.
+
+ @throws SQLException on error
*/
public void checkCommit() throws SQLException;
@@ -73,14 +88,22 @@ public interface BrokeredConnectionContr
/**
Can cursors be held across commits.
- @param downgrade true to downgrade the holdability,
- false to throw an exception.
+
+ @param holdability Current holdability
+ @param downgrade true to downgrade the holdability, false to throw an exception.
+
+ @return whether cursors can be held across commits
+
+ @throws SQLException on error
*/
public int checkHoldCursors(int holdability, boolean downgrade)
throws SQLException;
/**
Returns true if isolation level has been set using JDBC/SQL.
+
+ @return true if isolation level has been set by user
+ @throws SQLException on error
*/
public boolean isIsolationLevelSetUsingSQLorJDBC() throws SQLException;
/**
@@ -88,6 +111,8 @@ public interface BrokeredConnectionContr
BrokeredConnection. It will get set to true when isolation level
is set using JDBC/SQL. It will get reset to false at the start
and the end of a global transaction.
+
+ @throws SQLException on error
*/
public void resetIsolationLevelFlag() throws SQLException;
@@ -100,37 +125,57 @@ public interface BrokeredConnectionContr
/**
Close called on BrokeredConnection. If this call
returns true then getRealConnection().close() will be called.
+
+ @return true if getRealConnection().close() will be called
+
+ @throws SQLException on error
*/
public boolean closingConnection() throws SQLException;
/**
Optionally wrap a Statement with another Statement.
+
+ @param realStatement The original statement
+ @return a wrapper statement
+
+ @throws SQLException on error
*/
public Statement wrapStatement(Statement realStatement) throws SQLException;
/**
Optionally wrap a PreparedStatement with another PreparedStatement.
+
+ @param realStatement The original statement
+ @param sql The sql to use
+ @param generateKeys Key generation information
+ @return a wrapper statement
+ @throws SQLException on error
*/
public PreparedStatement wrapStatement(PreparedStatement realStatement, String sql, Object generateKeys) throws SQLException;
/**
Optionally wrap a CallableStatement with an CallableStatement.
+
+ @param realStatement The original statement
+ @param sql The sql text
+ @return a wrapper callable statement
+ @throws SQLException on error
*/
public CallableStatement wrapStatement(CallableStatement realStatement, String sql) throws SQLException;
- /**
- * Close called on the associated PreparedStatement object
- * @param statement PreparedStatement object on which the close event
- * occurred
- */
- public void onStatementClose(PreparedStatement statement);
+ /**
+ * Close called on the associated PreparedStatement object
+ * @param statement PreparedStatement object on which the close event
+ * occurred
+ */
+ public void onStatementClose(PreparedStatement statement);
- /**
- * Error occurred on associated PreparedStatement object
- * @param statement PreparedStatement object on which the
- * error occured
- * @param sqle The SQLExeption that caused the error
- */
- public void onStatementErrorOccurred(PreparedStatement statement,SQLException sqle);
+ /**
+ * Error occurred on associated PreparedStatement object
+ * @param statement PreparedStatement object on which the
+ * error occured
+ * @param sqle The SQLExeption that caused the error
+ */
+ public void onStatementErrorOccurred(PreparedStatement statement,SQLException sqle);
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredPreparedStatement.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredPreparedStatement.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredPreparedStatement.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredPreparedStatement.java Thu Jun 14 23:29:38 2018
@@ -708,6 +708,11 @@ public class BrokeredPreparedStatement e
/**
Create a duplicate PreparedStatement to this, including state, from the passed in Connection.
+
+ @param conn The current connection
+ @param oldStatement The old statement
+ @return a new PreparedStatement
+ @throws SQLException on error
*/
public PreparedStatement createDuplicateStatement(Connection conn, PreparedStatement oldStatement) throws SQLException {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredStatementControl.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredStatementControl.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredStatementControl.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/BrokeredStatementControl.java Thu Jun 14 23:29:38 2018
@@ -33,38 +33,48 @@ public interface BrokeredStatementContro
Returns the holdability that should be
used which may be different from the passed
in holdabilty.
+
+ @param holdability The desired holdability
+ @return the actual holdability
+ @throws SQLException on error
*/
public int checkHoldCursors(int holdability) throws SQLException;
/**
* Close the real JDBC Statement when this is controlling a Statement.
- * @throws SQLException
+ * @throws SQLException on error
*/
public void closeRealStatement() throws SQLException;
/**
* Close the real JDBC CallableStatement when this is controlling a
* CallableStatement.
- * @throws SQLException
+ * @throws SQLException on error
*/
public void closeRealCallableStatement() throws SQLException;
/**
* Close the real JDBC CallableStatement when this is controlling a
* PreparedStatement.
- * @throws SQLException
+ * @throws SQLException on error
*/
public void closeRealPreparedStatement() throws SQLException;
/**
Return the real JDBC statement for the brokered statement
when this is controlling a Statement.
+
+ @return the real statement
+ @throws SQLException on error
*/
public Statement getRealStatement() throws SQLException;
/**
Return the real JDBC PreparedStatement for the brokered statement
when this is controlling a PreparedStatement.
+
+ @return the real prepared statement
+ @throws SQLException on error
*/
public PreparedStatement getRealPreparedStatement() throws SQLException;
@@ -72,12 +82,17 @@ public interface BrokeredStatementContro
/**
Return the real JDBC CallableStatement for the brokered statement
when this is controlling a CallableStatement.
+
+ @return the real callable statement
+ @throws SQLException on error
*/
public CallableStatement getRealCallableStatement() throws SQLException;
/**
Optionally wrap a returned ResultSet in another ResultSet.
@param s Statement that created the ResultSet.
+ @param rs The ResultSet to wrap
+ @return the wrapper ResultSet
*/
public ResultSet wrapResultSet(Statement s, ResultSet rs);
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ConnectionContext.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ConnectionContext.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ConnectionContext.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ConnectionContext.java Thu Jun 14 23:29:38 2018
@@ -41,6 +41,8 @@ public interface ConnectionContext
DriverManager.getConnection("jdbc:default:connection");
</PRE>
+ @param internal True if the connection should be internal
+ @return a nested connection
@exception SQLException Parent connection has been closed.
*/
public Connection getNestedConnection(boolean internal) throws SQLException;
@@ -49,6 +51,7 @@ public interface ConnectionContext
* Get a jdbc ResultSet based on the execution ResultSet.
*
* @param executionResultSet a result set as gotten from execution
+ * @return a JDBC ResultSet
*
* @exception java.sql.SQLException on error
*/
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/DRDAServerStarter.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/DRDAServerStarter.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/DRDAServerStarter.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/DRDAServerStarter.java Thu Jun 14 23:29:38 2018
@@ -102,6 +102,7 @@ public final class DRDAServerStarter imp
* @param portNumber portNumber to listen on
* @param userName the user name for actions requiring authorization
* @param password the password for actions requiring authorization
+ * @param consoleWriter the diagnostic log writer
*/
public void setStartInfo(InetAddress listenAddress, int portNumber,
String userName, String password,
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EmbeddedDataSourceInterface.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EmbeddedDataSourceInterface.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EmbeddedDataSourceInterface.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EmbeddedDataSourceInterface.java Thu Jun 14 23:29:38 2018
@@ -64,7 +64,7 @@ public interface EmbeddedDataSourceInter
* @param requestPassword {@code true} if the password came from the
* getConnection() call with user and password arguments..
* @return user connection
- * @throws SQLException
+ * @throws SQLException on error
*/
public Connection getConnection(String username,
String password,
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineConnection.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineConnection.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineConnection.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineConnection.java Thu Jun 14 23:29:38 2018
@@ -37,6 +37,8 @@ public interface EngineConnection extend
/**
* Set the DRDA identifier for this connection.
+ *
+ * @param drdaID The DRDA identifier
*/
public void setDrdaID(String drdaID);
@@ -58,12 +60,16 @@ public interface EngineConnection extend
* level == ExecutionContext.UNSPECIFIED_ISOLATION,
* the statement won't be prepared with an isolation level.
*
- *
+ * @throws SQLException on error
*/
public void setPrepareIsolation(int level) throws SQLException;
/**
- * Return prepare isolation
+ * Return prepare isolation
+ *
+ * @return the isolation level
+ *
+ * @throws SQLException on error
*/
public int getPrepareIsolation()
throws SQLException;
@@ -72,6 +78,8 @@ public interface EngineConnection extend
* Add a SQLWarning to this Connection object.
* @param newWarning Warning to be added, will be chained to any
* existing warnings.
+ *
+ * @throws SQLException on error
*/
public void addWarning(SQLWarning newWarning)
throws SQLException;
@@ -80,6 +88,8 @@ public interface EngineConnection extend
* Get the LOB reference corresponding to the locator.
* @param key the integer that represents the LOB locator value.
* @return the LOB Object corresponding to this locator.
+ *
+ * @throws SQLException on error
*/
public Object getLOBMapping(int key) throws SQLException;
@@ -87,7 +97,7 @@ public interface EngineConnection extend
* Obtain the name of the current schema, so that the NetworkServer can
* use it for piggy-backing
* @return the current schema name
- * @throws java.sql.SQLException
+ * @throws java.sql.SQLException on error
*/
public String getCurrentSchemaName() throws SQLException;
@@ -98,6 +108,7 @@ public interface EngineConnection extend
* Note that resetting the transaction isolation level is not performed as
* part of this method. Temporary tables, IDENTITY_VAL_LOCAL and current
* schema are reset.
+ * @throws java.sql.SQLException on error
*/
public void resetFromPool() throws SQLException;
@@ -109,11 +120,16 @@ public interface EngineConnection extend
/**
* Get the name of the current schema.
+ *
+ * @return the current schema name
+ * @throws java.sql.SQLException on error
*/
public String getSchema() throws SQLException;
/**
* Set the default schema for the Connection.
+ * @param schemaName The new default schema
+ * @throws java.sql.SQLException on error
*/
public void setSchema( String schemaName ) throws SQLException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EnginePreparedStatement.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EnginePreparedStatement.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EnginePreparedStatement.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EnginePreparedStatement.java Thu Jun 14 23:29:38 2018
@@ -37,6 +37,7 @@ public interface EnginePreparedStatement
* the caller may assume that a recompilation has not taken place, i.e.
* meta-data are (also) unchanged.
* @return version counter
+ * @throws SQLException on error
*/
public long getVersionCounter() throws SQLException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineResultSet.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineResultSet.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineResultSet.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/EngineResultSet.java Thu Jun 14 23:29:38 2018
@@ -32,6 +32,8 @@ public interface EngineResultSet extends
/**
* Is this result set from a select for update statement?
+ *
+ * @return true if this is a select for update statement's ResultSet
*/
public boolean isForUpdate();
@@ -39,9 +41,9 @@ public interface EngineResultSet extends
* Is the designated columnIndex a null data value?
* This is used by EXTDTAInputStream to get the null value without
* retrieving the underlying data value.
- * @param columnIndex
+ * @param columnIndex Column position
* @return true if the data value at columnIndex for the current row is null
- * @throws SQLException
+ * @throws SQLException on error
*/
public boolean isNull(int columnIndex) throws SQLException;
@@ -51,7 +53,7 @@ public interface EngineResultSet extends
*
* @param columnIndex column to access
* @return length of data value
- * @throws SQLException
+ * @throws SQLException on error
* @see org.apache.derby.iapi.types.DataValueDescriptor#getLength()
*/
public int getLength(int columnIndex) throws SQLException;
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=1833569&r1=1833568&r2=1833569&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 Thu Jun 14 23:29:38 2018
@@ -83,7 +83,7 @@ public class FailedProperties40 {
/**
* <code>getProperties</code> provides a
- * <code>Map&glt;String,ClientInfoStatus></code> object describing the
+ * <code>Map<String,ClientInfoStatus></code> object describing the
* failed properties (as specified in the javadoc for
* java.sql.SQLClientInfoException).
*