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 [2/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...
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/InternalDriver.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/InternalDriver.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/InternalDriver.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/InternalDriver.java Thu Jun 14 23:29:38 2018
@@ -488,6 +488,9 @@ public class InternalDriver implements M
It also means that we don't add our attributes into the user's
own property object.
+ @param url The properties-bearing URL
+ @param info Existing properties
+ @return a Derby properties object
@exception SQLException thrown if URL form bad
*/
protected FormatableProperties getAttributes(String url, Properties info)
@@ -701,6 +704,8 @@ public class InternalDriver implements M
/**
Return true if this driver is active. Package private method.
+
+ @return true if this driver is active
*/
public boolean isActive() {
return active;
@@ -735,6 +740,16 @@ public class InternalDriver implements M
}
/**
+ @param conn Derby connection
+ @param stmt Statement text
+ @param forMetaData True if this is for metadata
+ @param resultSetType Type of ResultSet
+ @param resultSetConcurrency Concurrency setting
+ @param resultSetHoldability Holdability setting
+ @param autoGeneratedKeys The autogenerated keys
+ @param columnIndexes Column positions
+ @param columnNames The column names
+ @return a PreparedStatement
@exception SQLException if fails to create statement
*/
public PreparedStatement newEmbedPreparedStatement(
@@ -756,6 +771,12 @@ public class InternalDriver implements M
}
/**
+ @param conn Derby connection
+ @param stmt Statement text
+ @param resultSetType Type of ResultSet
+ @param resultSetConcurrency Concurrency setting
+ @param resultSetHoldability Holdability setting
+ @return a CallableStatement
@exception SQLException if fails to create statement
*/
public CallableStatement newEmbedCallableStatement(
@@ -772,7 +793,11 @@ public class InternalDriver implements M
/**
* Return a new java.sql.DatabaseMetaData instance for this implementation.
- @exception SQLException on failure to create.
+ *
+ * @param conn Derby connection
+ * @param dbname Database name
+ * @return a new java.sql.DatabaseMetaData instance for this implementation
+ * @exception SQLException on failure to create.
*/
public DatabaseMetaData newEmbedDatabaseMetaData(
EmbedConnection conn, String dbname) throws SQLException {
@@ -785,9 +810,9 @@ public class InternalDriver implements M
* @param results Top level of language result set tree
* @param forMetaData Is this for meta-data
* @param statement The statement that is creating the SQL ResultSet
- * @param isAtomic
+ * @param isAtomic True if the ResultSet is atomic
* @return a new java.sql.ResultSet
- * @throws SQLException
+ * @throws SQLException on error
*/
public EmbedResultSet newEmbedResultSet(EmbedConnection conn,
ResultSet results, boolean forMetaData, EmbedStatement statement,
@@ -801,6 +826,7 @@ public class InternalDriver implements M
*
* @param columnInfo a ResultColumnDescriptor that stores information
* about the columns in a ResultSet
+ * @return ResultSet metadata
*/
public EmbedResultSetMetaData newEmbedResultSetMetaData(
ResultColumnDescriptor[] columnInfo) {
@@ -809,6 +835,11 @@ public class InternalDriver implements M
/**
* Return a new BrokeredConnection for this implementation.
+ *
+ * @param control Control variable
+ * @return a brokered connection
+ *
+ * @throws SQLException on error
*/
public BrokeredConnection newBrokeredConnection(
BrokeredConnectionControl control) throws SQLException {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/JDBCBoot.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/JDBCBoot.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/JDBCBoot.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/JDBCBoot.java Thu Jun 14 23:29:38 2018
@@ -78,6 +78,8 @@ public class JDBCBoot {
Boot a system requesting a JDBC driver but only if there is
no current JDBC driver that is handling the required protocol.
+ @param protocol The database protocol
+ @param logging The diagnostic log writer
*/
public void boot(String protocol, final PrintWriter logging) {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ResourceAdapter.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ResourceAdapter.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ResourceAdapter.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/jdbc/ResourceAdapter.java Thu Jun 14 23:29:38 2018
@@ -164,7 +164,7 @@ import org.apache.derby.shared.common.er
<BR> First some ugly pictures. Some links are not shown to reduce
clutter. Externally visible object is in <B>bold</B>.
- <P><PRE>
+ <PRE>
*
* When user ask for an XAConnection via a XADataSource, the following objects
* exists
@@ -392,6 +392,8 @@ public interface ResourceAdapter {
/**
Let a xaResource get the XAResourceManager to commit or rollback an
in-doubt transaction.
+
+ @return the XA resource manager
*/
XAResourceManager getXAResourceManager();
@@ -402,6 +404,8 @@ public interface ResourceAdapter {
/**
Is the Resource Manager active
+
+ @return true if the resource manager is active
*/
boolean isActive();
@@ -418,6 +422,8 @@ public interface ResourceAdapter {
* XAResource instance, and rollback of the global transaction.
* @param xid tranaction id to cancel
* @param messageId error to report when canceling
+ *
+ * @throws XAException on error
*/
public void cancelXATransaction(XAXactId xid, String messageId)
throws XAException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheFactory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheFactory.java Thu Jun 14 23:29:38 2018
@@ -34,7 +34,7 @@ public interface CacheFactory {
@param name The name of the cache
@param initialSize The initial capacity of the cache
@param maximumSize The maximum number of objects the cache will hold
-
+ @return a cache manager
*/
public CacheManager newCacheManager(CacheableFactory holderFactory, String name,
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheManager.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheManager.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheManager.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheManager.java Thu Jun 14 23:29:38 2018
@@ -62,6 +62,7 @@ public interface CacheManager {
</PRE>
+ @param key The object key
@return A reference to an object in the cache, or null if the object cannot be found.
@exception StandardException Standard Derby error policy.
@@ -93,6 +94,8 @@ public interface CacheManager {
}
</PRE>
+ @param key The object key
+ @return the matching Cacheable
@exception StandardException Standard Derby error policy.
*/
public Cacheable findCached(Object key) throws StandardException;
@@ -131,6 +134,8 @@ public interface CacheManager {
</PRE>
+ @param key The object key
+ @param createParameter Creation details
@return A reference to an object in the cache.
@exception StandardException Standard Derby error policy.
@@ -197,6 +202,7 @@ public interface CacheManager {
be able to handle a partial key, e.g. a page has PageKey but a clean
may pass a ContainerKey which will discard all pages in that container.
+ @param partialKey Key fragment to be matched
@exception StandardException Standard Derby error policy.
*/
public void clean(Matchable partialKey) throws StandardException;
@@ -234,6 +240,8 @@ public interface CacheManager {
in the background. The caller must ensure that it has exclusive access
to the cache when this method is called. No synchronization is required
in the implementations of this method.
+
+ @param daemon A daemon service
*/
public void useDaemonService(DaemonService daemon);
@@ -252,6 +260,7 @@ public interface CacheManager {
a partial key, e.g. a page has PageKey but a discard may pass a ContainerKey which will discard
all pages in that container.
<P>
+ @param partialKey Key fragment to be matched
@return true if discard has successful gotten rid of all objects that
match the partial or exact key. False if some objects that matches
were not gotten rid of because it was kept.
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/Cacheable.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/Cacheable.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/Cacheable.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/Cacheable.java Thu Jun 14 23:29:38 2018
@@ -32,13 +32,11 @@ import org.apache.derby.shared.common.er
<P>
A Cacheable object has five states:
<OL>
- <OL>
- <LI> No identity - The object is only accessable by the cache manager
- <LI> Identity, clean, unkept - The object has an identity, is clean but is only accessable by the cache manager
- <LI> Identity, clean, kept - The object has an identity, is clean, and is in use by one or more threads
- <LI> Identity, kept, dirty - The object has an identity, is dirty, and is in use by one or more threads
- <LI> Identity, unkept, dirty - The object has an identity, is dirty but is only accessable by the cache manager
- </OL>
+ <LI> No identity - The object is only accessable by the cache manager</LI>
+ <LI> Identity, clean, unkept - The object has an identity, is clean but is only accessable by the cache manager</LI>
+ <LI> Identity, clean, kept - The object has an identity, is clean, and is in use by one or more threads</LI>
+ <LI> Identity, kept, dirty - The object has an identity, is dirty, and is in use by one or more threads</LI>
+ <LI> Identity, unkept, dirty - The object has an identity, is dirty but is only accessable by the cache manager</LI>
</OL>
<BR>
While the object is kept it is guaranteed
@@ -79,6 +77,7 @@ public interface Cacheable {
<BR> MT - single thread required - Method must only be called be cache manager
and the cache manager will guarantee only one thread can be calling it.
+ @param key The handle on the cacheable
@return an object reference if the object can take on the identity, null otherwise.
@exception StandardException Standard Derby Policy
@@ -110,6 +109,8 @@ public interface Cacheable {
<BR> MT - single thread required - Method must only be called be cache manager
and the cache manager will guarantee only one thread can be calling it.
+ @param key The handle on the cacheable
+ @param createParameter Creation details
@return an object reference if the object can take on the identity, null otherwise.
@exception StandardException If forCreate is true and the object cannot be created.
@@ -134,15 +135,19 @@ public interface Cacheable {
<BR> MT - thread safe.
+ @return the object identity
+
*/
public Object getIdentity();
/**
- Returns true of the object is dirty.
+ Returns true if the object is dirty.
May be called when the object is kept or unkept.
- <BR> MT - thread safe
+ <BR> MT - thread safe
+
+ @return true if the object is dirty
*/
public boolean isDirty();
@@ -164,6 +169,7 @@ public interface Cacheable {
responsibility of the object implementing Cacheable to ensure any users of the
object do not conflict with the clean call.
+ @param forRemove True if the object will be removed
@exception StandardException Standard Derby error policy.
*/
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheableFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheableFactory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheableFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/CacheableFactory.java Thu Jun 14 23:29:38 2018
@@ -22,14 +22,16 @@
package org.apache.derby.iapi.services.cache;
/**
+ <P>
Any object that implements this interface can be cached using the services of
the CacheManager/CacheFactory. In addition to implementing this interface the
class must be public and it must have a public no-arg constructor. This is because
the cache manager will construct objects itself and then set their identity
by calling the setIdentity method.
+ </P>
<P>
A Cacheable object has five states:
- <OL>
+ </P>
<OL>
<LI> No identity - The object is only accessable by the cache manager
<LI> Identity, clean, unkept - The object has an identity, is clean but is only accessable by the cache manager
@@ -37,7 +39,6 @@ package org.apache.derby.iapi.services.c
<LI> Identity, kept, dirty - The object has an identity, is dirty, and is in use by one or more threads
<LI> Identity, unkept, dirty - The object has an identity, is dirty but is only accessable by the cache manager
</OL>
- </OL>
<BR>
While the object is kept it is guaranteed
not to change identity. While it is unkept no-one outside of the
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/ClassSize.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/ClassSize.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/ClassSize.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/cache/ClassSize.java Thu Jun 14 23:29:38 2018
@@ -251,12 +251,14 @@ public class ClassSize
* size of an array field does not depend on the size of the array. Similarly the size of
* an object (reference) field does not depend on the object.
*
- * @return the size estimate in bytes.
- *
* Note that this method will throw a SecurityException if the SecurityManager does not
* let this class execute the method Class.getDeclaredFields(). If this is a concern try
* to compute the size coefficients at build time.
* see org.apache.derbyBuild.ClassSizeCrawler
+ *
+ * @param cl A class
+ * @return the size estimate in bytes.
+ *
* @see #estimateBaseFromCatalog
*/
public static int estimateBase( Class cl)
@@ -287,6 +289,7 @@ public class ClassSize
/**
* Estimate the size of a string.
*
+ * @param str The string
* @return the estimated size, in bytes
*/
public static int estimateMemoryUsage( String str)
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/Context.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/Context.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/Context.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/Context.java Thu Jun 14 23:29:38 2018
@@ -59,6 +59,8 @@ public interface Context
/**
* Returns the context manager that has stored this
* context in its stack.
+ *
+ * @return the context manager
*/
public ContextManager getContextManager();
@@ -75,6 +77,8 @@ public interface Context
* field with the name CONTEXT_ID. For example,
* see org.apache.derby.iapi.sql.compile.CompilerContext.CONTEXT_ID.
* @see org.apache.derby.iapi.sql.compile.CompilerContext
+ *
+ * @return the current id name
*/
public String getIdName();
@@ -109,6 +113,7 @@ public interface Context
* is an instance of StandardException that is more severe than the original error
* or the new exception is a not an instance of StandardException (e.g java.lang.NullPointerException).
*
+ * @param error The original error
* @exception StandardException thrown if cleanup goes awry
*/
public void cleanupOnError(Throwable error)
@@ -138,6 +143,9 @@ public interface Context
* interested in session level errors because they both have clean up to do.
* This method allows both of them to return false so that all such handlers
* under them can do their clean up.
+ *
+ * @param severity The severity level
+ * @return whether or not this context is the "last" handler for a severity level
*/
public boolean isLastHandler(int severity);
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextManager.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextManager.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextManager.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextManager.java Thu Jun 14 23:29:38 2018
@@ -471,6 +471,8 @@ cleanup: for (int index = holder.size()
/**
Set the locale for this context.
+
+ @param finder The local finder
*/
public void setLocaleFinder(LocaleFinder finder) {
this.finder = finder;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextService.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextService.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextService.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/context/ContextService.java Thu Jun 14 23:29:38 2018
@@ -223,6 +223,7 @@ public final class ContextService //OLD
Find the context with the given name in the context service factory
loaded for the system.
+ @param contextId The handle on the context
@return The requested context, null if it doesn't exist.
*/
public static Context getContext(String contextId)
@@ -245,6 +246,7 @@ public final class ContextService //OLD
This version will not do any debug checking, but return null
quietly if it runs into any problems.
+ @param contextId The handle on the context
@return The requested context, null if it doesn't exist.
*/
public static Context getContextOrNull(String contextId)
@@ -306,6 +308,8 @@ public final class ContextService //OLD
* Break the link between the current Thread and the passed
* in ContextManager. Called in a pair with setCurrentContextManager,
* see that method for details.
+ *
+ * @param cm The context manager
*/
public void resetCurrentContextManager(ContextManager cm) {
ThreadLocal<Object> tcl = threadContextList;
@@ -503,6 +507,8 @@ public final class ContextService //OLD
* <LI>A different ContextManager would be pushed during a call on
* a different embedded JDBC Connection in a procedure or function.
* </UL>
+ *
+ * @param cm The context manager
*/
public void setCurrentContextManager(ContextManager cm) {
@@ -529,6 +535,8 @@ public final class ContextService //OLD
* It's up to the caller to track this context manager and set it
* in the context manager list using setCurrentContextManager.
* We don't keep track of it due to this call being made.
+ *
+ * @return a new context manager
*/
public ContextManager newContextManager()
{
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactory.java Thu Jun 14 23:29:38 2018
@@ -66,6 +66,7 @@ public interface CipherFactory
Returns a CipherProvider which is the encryption or decryption engine.
@param mode is either ENCRYPT or DECRYPT. The CipherProvider can only
do encryption or decryption but not both.
+ @return a cipher provider
@exception StandardException Standard Derby Error Policy
*/
@@ -86,7 +87,9 @@ public interface CipherFactory
@param storageFactory storageFactory is used to access any stored data
that might be needed for verification process of the encryption key
@param properties properties at time of database connection as well as those in service.properties
- */
+
+ @throws StandardException on error
+ */
public void verifyKey(boolean create, StorageFactory storageFactory,Properties properties)
throws StandardException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactoryBuilder.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactoryBuilder.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactoryBuilder.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherFactoryBuilder.java Thu Jun 14 23:29:38 2018
@@ -42,7 +42,9 @@ public interface CipherFactoryBuilder
* for creating the cipher factory.
* @param newAttrs true, if cipher factory has to be created using
* the new attributes specified by the user.
- *
+ *
+ * @return a cipher factory
+ * @throws StandardException on error
*/
public CipherFactory createCipherFactory(boolean create,
Properties props,
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherProvider.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherProvider.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherProvider.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/crypto/CipherProvider.java Thu Jun 14 23:29:38 2018
@@ -95,6 +95,8 @@ public interface CipherProvider
/**
Returns the encryption block size used during creation of the encrypted database
+
+ @return the encryption block size
*/
public int getEncryptionBlockSize();
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/DaemonFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/DaemonFactory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/DaemonFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/DaemonFactory.java Thu Jun 14 23:29:38 2018
@@ -59,6 +59,8 @@ public interface DaemonFactory
/**
Create a new DaemonService with the default daemon timer delay.
+ @param name The name to use
+ @return a daemon service
@exception StandardException Standard Derby error policy
*/
public DaemonService createNewDaemon(String name) throws StandardException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/IndexStatisticsDaemon.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/IndexStatisticsDaemon.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/IndexStatisticsDaemon.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/IndexStatisticsDaemon.java Thu Jun 14 23:29:38 2018
@@ -27,21 +27,25 @@ import org.apache.derby.iapi.sql.diction
import org.apache.derby.iapi.sql.dictionary.TableDescriptor;
/**
+ * <p>
* Daemon acting as a coordinator for creating and updating index statistics.
+ * </p>
* <p>
* There are two modes of operation:
+ * </p>
* <ul> <li>explicit - generates index statistics due to an explict request from
* the user. The entrypoint is <tt>runExplicitly</tt>.</li>
* <li>background - generates index statistics as a background task due to
* an event that has triggered a statistics update. The entrypoint
* is <tt>schedule</tt>.</li>
- * <ul>
+ * </ul>
* <p>
* The modes differ in how the operation affects other operations in the running
* system, and also how errors are dealt with. The background mode will try to
* affect other operations as little as possible, and errors won't be reported
* unless they are severe. The explicit mode will do more to make sure the
* operation succeeds (for instance by using locks), and will report all errors.
+ * </p>
*/
public interface IndexStatisticsDaemon {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/Serviceable.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/Serviceable.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/Serviceable.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/daemon/Serviceable.java Thu Jun 14 23:29:38 2018
@@ -99,6 +99,8 @@ public interface Serviceable {
directly, like in post commit processing
<P>MT - MT safe
+
+ @return true if this should work as soon as possible
*/
public boolean serviceASAP();
@@ -107,7 +109,9 @@ public interface Serviceable {
If this work should be done immediately on the user thread then return true.
If it doesn't make any difference if this work is done on a the user thread
immediately or if it is performed by another thread asynchronously
- later, then return false.
+ later, then return false.
+
+ @return true if this work shold happen immediately on the user thread
*/
public boolean serviceImmediately();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/diag/Diagnosticable.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/diag/Diagnosticable.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/diag/Diagnosticable.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/diag/Diagnosticable.java Thu Jun 14 23:29:38 2018
@@ -86,6 +86,7 @@ public interface Diagnosticable
* be provided by a real implementation.
* <p>
*
+ * @param prop In/out argument for passing information
* @exception StandardException Standard Derby exception policy
**/
public void diag_detail(Properties prop) throws StandardException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/AccessibleByteArrayOutputStream.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/AccessibleByteArrayOutputStream.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/AccessibleByteArrayOutputStream.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/AccessibleByteArrayOutputStream.java Thu Jun 14 23:29:38 2018
@@ -53,6 +53,8 @@ public class AccessibleByteArrayOutputSt
* before any other calls to write to this stream are made.
Or promises to throw away references to the stream before
passing the array reference out of its control.
+
+ @return a byte array
*/
public byte[] getInternalByteArray() {
return buf;
@@ -61,7 +63,9 @@ public class AccessibleByteArrayOutputSt
/**
* Read the complete contents of the passed input stream
* into this byte array.
- * @throws IOException
+ *
+ * @param in The stream to read
+ * @throws IOException on error
*/
public void readFrom(InputStream in) throws IOException
{
@@ -81,6 +85,8 @@ public class AccessibleByteArrayOutputSt
* Note that no copy is made of the byte array from the
* input stream, it is up to the caller to ensure the correct
* co-ordination.
+ *
+ * @return an InputStream wrapping the byte array
*/
public InputStream getInputStream()
{
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayInputStream.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayInputStream.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayInputStream.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayInputStream.java Thu Jun 14 23:29:38 2018
@@ -57,7 +57,7 @@ public final class ArrayInputStream exte
/**
* Create an ArrayInputStream with the passed in data.
* The position is set to 0 and the limit is the entire byte array.
- * @param data
+ * @param data The data in the stream
*/
public ArrayInputStream(byte[] data) {
super();
@@ -72,6 +72,8 @@ public final class ArrayInputStream exte
/**
Set the array of bytes to be read.
Position is set to zero.
+
+ @param data The data in the stream
*/
public void setData(byte[] data) {
pageData = data;
@@ -81,7 +83,9 @@ public final class ArrayInputStream exte
/**
Return a reference to the array of bytes this stream is going to read
- from so that caller may load it with stuff
+ from so that caller may load it with stuff
+
+ @return the data in the stream
*/
public byte[] getData()
{
@@ -163,6 +167,8 @@ public final class ArrayInputStream exte
/**
A setLimit which also sets the position to be offset.
+ @param offset Offset into the stream
+ @param length New length
@exception IOException limit is out of range
*/
public void setLimit(int offset, int length) throws IOException {
@@ -555,6 +561,7 @@ public final class ArrayInputStream exte
* 4 byte- 1xxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx val > 16383 && <= MAX_INT
* </PRE>
*
+ * @return the uncompressed int
* @exception IOException if an I/O error happens
**/
public final int readCompressedInt()
@@ -638,7 +645,7 @@ public final class ArrayInputStream exte
*
* Formats are (with x representing value bits):
* <PRE>
- * value ≷= 16383 (0x3fff):
+ * value >= 16383 (0x3fff):
* 2 byte - 00xxxxxx xxxxxxxx
*
* value > 16383 && <= 0x3fffffff:
@@ -648,6 +655,8 @@ public final class ArrayInputStream exte
* 8 byte - 1xxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx
* </PRE>
*
+ * @return the uncompressed long
+ * @throws IOException on error
**/
public final long readCompressedLong()
throws IOException
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayOutputStream.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayOutputStream.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayOutputStream.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/ArrayOutputStream.java Thu Jun 14 23:29:38 2018
@@ -84,6 +84,9 @@ public class ArrayOutputStream extends O
/**
Set the position of the stream pointer.
+
+ @param newPosition The new postion to set
+ @throws IOException on error
*/
public void setPosition(int newPosition)
throws IOException {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CompressedNumber.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CompressedNumber.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CompressedNumber.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CompressedNumber.java Thu Jun 14 23:29:38 2018
@@ -59,6 +59,9 @@ public abstract class CompressedNumber {
4 byte - 1xxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx Represents the value > 16383 && <= MAX_INT
</PRE>
+ @param out Where to serialize the int value
+ @param value The value to serialize
+ @return the number of bytes written
@exception IOException value is negative or an exception was thrown by a method on out.
*/
@@ -89,6 +92,10 @@ public abstract class CompressedNumber {
/**
Write a compressed integer directly to an OutputStream.
+
+ @param out Where to serialize the int value
+ @param value The int value to serialize
+ @return the number of bytes written
@exception IOException an exception was thrown by a method on in.
*/
public static final int writeInt(OutputStream out, int value) throws IOException {
@@ -120,6 +127,9 @@ public abstract class CompressedNumber {
/**
Read an integer previously written by writeInt().
+ @param in Whence to read an int
+ @return the deserialized int value
+
@exception IOException an exception was thrown by a method on in.
*/
public static final int readInt(DataInput in) throws IOException {
@@ -178,6 +188,9 @@ public abstract class CompressedNumber {
/**
Read an integer previously written by writeInt().
+ @param in Whence to read an int
+ @return the deserialized int value
+
@exception IOException an exception was thrown by a method on in.
*/
public static final int readInt(InputStream in) throws IOException {
@@ -258,13 +271,10 @@ public abstract class CompressedNumber {
}
/**
- Skip an integer previously written by writeInt().
-
- @exception IOException an exception was thrown by a method on in.
- */
-
- /**
Return the number of bytes that would be written by a writeInt call
+
+ @param value The int value to be serialized
+ @return the number of bytes which would be written
*/
public static final int sizeInt(int value) {
if (value <= 0x3f) {
@@ -286,6 +296,9 @@ public abstract class CompressedNumber {
8 byte - 1xxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx Represents the value > 0x3fffffff && <= MAX_LONG
</PRE>
+ @param out Where to write the long value
+ @param value The long value to write
+ @return the number of bytes written
@exception IOException value is negative or an exception was thrown by a method on out.
*/
@@ -323,6 +336,10 @@ public abstract class CompressedNumber {
/**
Write a compressed integer only supporting signed values.
+ @param out Where to write the long
+ @param value The long to write
+ @return the number of bytes written
+
@exception IOException value is negative or an exception was thrown by a method on out.
*/
public static final int writeLong(OutputStream out, long value) throws IOException {
@@ -360,6 +377,9 @@ public abstract class CompressedNumber {
/**
Read a long previously written by writeLong().
+ @param in Whence to read a long value
+ @return the deserialized long value
+
@exception IOException an exception was thrown by a method on in.
*/
public static final long readLong(DataInput in) throws IOException {
@@ -401,6 +421,9 @@ public abstract class CompressedNumber {
/**
Read a long previously written by writeLong().
+ @param in Whence to read the long value
+ @return the deserialized long value
+
@exception IOException an exception was thrown by a method on in.
*/
public static final long readLong(InputStream in) throws IOException {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CounterOutputStream.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CounterOutputStream.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CounterOutputStream.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/CounterOutputStream.java Thu Jun 14 23:29:38 2018
@@ -53,6 +53,8 @@ public class CounterOutputStream extends
/**
Get count of bytes written to the stream since the last
reset() call.
+
+ @return the number of bytes written since the last reset() call
*/
public int getCount() {
return count;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/DynamicByteArrayOutputStream.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/DynamicByteArrayOutputStream.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/DynamicByteArrayOutputStream.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/DynamicByteArrayOutputStream.java Thu Jun 14 23:29:38 2018
@@ -131,6 +131,8 @@ public class DynamicByteArrayOutputStrea
Get a reference to the byte array stored in the byte array output
stream. Note that the byte array may be longer that getPosition().
Bytes beyond and including the current poistion are invalid.
+
+ @return the wrapped byte array
*/
public byte[] getByteArray()
{
@@ -139,6 +141,8 @@ public class DynamicByteArrayOutputStrea
/**
Get the number of bytes that was used.
+
+ @return the number of used bytes
*/
public int getUsed()
{
@@ -147,6 +151,8 @@ public class DynamicByteArrayOutputStrea
/**
Get the current position in the stream
+
+ @return the current position in the stream
*/
public int getPosition()
{
@@ -155,6 +161,8 @@ public class DynamicByteArrayOutputStrea
/**
Get the current position in the stream
+
+ @return the current position in the stream
*/
public int getBeginPosition()
{
@@ -166,6 +174,8 @@ public class DynamicByteArrayOutputStrea
It is up to the caller to make sure the stream has no gap of garbage in
it or useful information is not left out at the end because the stream
does not remember anything about the previous position.
+
+ @param newPosition The new position of the stream pointer
*/
public void setPosition(int newPosition)
{
@@ -187,6 +197,8 @@ public class DynamicByteArrayOutputStrea
Set the begin position of the stream pointer.
If the newBeginPosition is larger than the stream itself,
then, the begin position is not set.
+
+ @param newBeginPosition The new start position
*/
public void setBeginPosition(int newBeginPosition)
{
@@ -200,6 +212,8 @@ public class DynamicByteArrayOutputStrea
/**
Shrink the buffer left by the amount given. Ie.
bytes from 0 to amountToShrinkBy are thrown away
+
+ @param amountToShrinkBy The amount to lop off
*/
public void discardLeft(int amountToShrinkBy) {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FileUtil.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FileUtil.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FileUtil.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FileUtil.java Thu Jun 14 23:29:38 2018
@@ -60,9 +60,9 @@ public abstract class FileUtil {
dependent. This method removes the directory
and all of its contents.
+ @param directory The directory to remove
@return true if the complete directory was removed, false if it could not be.
If false is returned then some of the files in the directory may have been removed.
-
*/
public static boolean removeDirectory(File directory) {
@@ -456,6 +456,9 @@ public abstract class FileUtil {
expressed as an URL. If the filename is not an URL, then nothing is done.
Otherwise, an URL like 'file:///tmp/foo.txt' is transformed into the legal
file name '/tmp/foo.txt'.
+
+ @param originalName The original url
+ @return the stripped url
*/
public static String stripProtocolFromFileName( String originalName )
{
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableArrayHolder.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableArrayHolder.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableArrayHolder.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableArrayHolder.java Thu Jun 14 23:29:38 2018
@@ -98,6 +98,7 @@ public class FormatableArrayHolder imple
* Get the held array of formatables, and return
* it in an array that is an instance of {@code arrayClass}.
*
+ * @param <E> The type of the array cell
* @param arrayClass the type of array to return
*
* @return an array of formatables
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableBitSet.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableBitSet.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableBitSet.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableBitSet.java Thu Jun 14 23:29:38 2018
@@ -104,6 +104,8 @@ public final class FormatableBitSet impl
/**
* Constructs a Bit with the initial number of bits
+ *
+ * @param numBits The number of bits in the set
*/
public FormatableBitSet(int numBits)
{
@@ -500,6 +502,7 @@ public final class FormatableBitSet impl
* Bit isSet
*
* @param position the bit to check
+ * @return true if the bit is set
*
*/
public final boolean isSet(int position)
@@ -515,6 +518,7 @@ public final class FormatableBitSet impl
* Bit get -- alias for isSet()
*
* @param position the bit to check
+ * @return true if the bit is set
*
*/
public final boolean get(int position)
@@ -623,6 +627,9 @@ public final class FormatableBitSet impl
* Statically calculates how many bits can fit into the number of
* bytes if this Bit object is externalized. Only valid for this
* implementation of Bit.
+ *
+ * @param numBytes Number of bits in given number of bytes
+ * @return the corresponding bit count
*/
public static int maxBitsForSpace(int numBytes)
{
@@ -749,6 +756,8 @@ public final class FormatableBitSet impl
/**
* Copy the bytes from another FormatableBitSet. Assumes that this bit set
* is at least as large as the argument's bit set.
+ *
+ * @param that Bit set to copy
*/
public void copyFrom( FormatableBitSet that )
{
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableInstanceGetter.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableInstanceGetter.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableInstanceGetter.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/FormatableInstanceGetter.java Thu Jun 14 23:29:38 2018
@@ -54,6 +54,8 @@ public abstract class FormatableInstance
/**
* Set the format identifier that this instance will be loading from disk.
+ *
+ * @param fmtId A format identifier
*/
public final void setFormatId(int fmtId) {
this.fmtId = fmtId;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/InputStreamUtil.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/InputStreamUtil.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/InputStreamUtil.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/InputStreamUtil.java Thu Jun 14 23:29:38 2018
@@ -35,6 +35,8 @@ public final class InputStreamUtil {
Read an unsigned byte from an InputStream, throwing an EOFException
if the end of the input is reached.
+ @param in Whence to read a byte
+ @return the byte
@exception IOException if an I/O error occurs.
@exception EOFException if the end of the stream is reached
@@ -52,6 +54,10 @@ public final class InputStreamUtil {
/**
Read a number of bytes into an array.
+ @param in Whence to read
+ @param b The byte array to fill
+ @param offset Position in byte array where we should start writing
+ @param len Number of bytes to read
@exception IOException if an I/O error occurs.
@exception EOFException if the end of the stream is reached
@@ -79,6 +85,11 @@ public final class InputStreamUtil {
(InputStream.read(byte[],int,int) does not guarantee to read len bytes
even if it can do so without reaching EOF or raising an exception.)
+ @param in Whence to read
+ @param b The byte array to fill
+ @param offset Position in byte array where we should start writing
+ @param len Number of bytes to read
+ @return the number of bytes read
@exception IOException if an I/O error occurs.
*/
public static int readLoop(InputStream in,
@@ -125,10 +136,8 @@ public final class InputStreamUtil {
/**
* Skips requested number of bytes,
* throws EOFException if there is too few bytes in the stream.
- * @param is
- * InputStream to be skipped.
- * @param skippedBytes
- * number of bytes to skip. if skippedBytes ≷= zero, do nothing.
+ * @param is InputStream to be skipped.
+ * @param skippedBytes number of bytes to skip. if skippedBytes >= zero, do nothing.
* @throws EOFException
* if EOF meets before requested number of bytes are skipped.
* @throws IOException
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/Limit.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/Limit.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/Limit.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/Limit.java Thu Jun 14 23:29:38 2018
@@ -41,6 +41,7 @@ public interface Limit {
<P> On output classes (e.g. OutputStream) any attempt to write
more beyond the limit will result in an EOFException
+ @param length The length to set
@exception IOException IOException from some underlying stream
@exception java.io.EOFException The set limit would exceed
the available data in the stream.
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitInputStream.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitInputStream.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitInputStream.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitInputStream.java Thu Jun 14 23:29:38 2018
@@ -36,6 +36,8 @@ public class LimitInputStream extends Fi
/**
Construct a LimitInputStream and call the clearLimit() method.
+
+ @param in InputStream to wrap
*/
public LimitInputStream(InputStream in) {
super(in);
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitReader.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitReader.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitReader.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/LimitReader.java Thu Jun 14 23:29:38 2018
@@ -36,6 +36,8 @@ public final class LimitReader extends R
/**
Construct a LimitReader and call the clearLimit() method.
+
+ @param reader Reader to wrap
*/
public LimitReader(Reader reader)
{
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/RegisteredFormatIds.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/RegisteredFormatIds.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/RegisteredFormatIds.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/RegisteredFormatIds.java Thu Jun 14 23:29:38 2018
@@ -538,9 +538,17 @@ private static final String[] TwoByte
/* 477 */ "org.apache.derby.impl.sql.execute.MergeConstantAction",
};
- /** Return the number of two-byte format ids */
+ /**
+ * Return the number of two-byte format ids
+ * @return the number of two-byte format ids
+ */
public static int countTwoByteIDs() { return TwoByte.length; }
- /** Return the class name bound to an index into TwoByte */
+ /**
+ * Return the class name bound to an index into TwoByte
+ *
+ * @param idx Index into TwoByte
+ * @return the class name located there
+ */
public static String classNameForTwoByteID( int idx ) { return TwoByte[ idx ]; }
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/StreamStorable.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/StreamStorable.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/StreamStorable.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/io/StreamStorable.java Thu Jun 14 23:29:38 2018
@@ -40,12 +40,15 @@ public interface StreamStorable
{
/**
Return the on-disk stream state of the object.
-
+
+ @return a stream to read the object state
**/
public InputStream returnStream();
/**
sets the on-disk stream state for the object.
+
+ @param newStream The new stream to use
**/
public void setStream(InputStream newStream);
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/jmx/ManagementService.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/jmx/ManagementService.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/jmx/ManagementService.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/jmx/ManagementService.java Thu Jun 14 23:29:38 2018
@@ -25,19 +25,27 @@ import org.apache.derby.shared.common.er
import org.apache.derby.mbeans.ManagementMBean;
/**
+* <p>
* This interface represents a Management Service. An implementation of this
* service is started by the Derby monitor if the system property derby.system.jmx has
* been set. The following services are provided:
+* </p>
*
-* <li> Create and start an instance of MBean server to register MBeans.
-* <li> Create managed beans (MBeans) to instrument derby resources for
-* management and monitoring.
+* <ul>
+* <li> Create and start an instance of MBean server to register MBeans.</li>
+* <li> Create managed beans (MBeans) to instrument derby resources for
+* management and monitoring.</li>
+* </ul>
*
+* <p>
* The following code can be used to locate an instance of this service
* if running.
+* </p>
*
+* <p>
* ManagementService ms = (ManagementService)
* Monitor.getSystemModule(Module.JMX);
+* </p>
*
*/
public interface ManagementService extends ManagementMBean {
@@ -51,14 +59,17 @@ public interface ManagementService exten
* Registers an MBean with the MBean server.
* The mbean will be unregistered automatically when Derby shuts down.
*
+ *
+ * @param <T> The kind of bean
* @param bean The MBean to wrap with a StandardMBean and register
* @param beanInterface The management interface for the MBean.
* @param keyProperties The String representation of the MBean's key properties,
* they will be added into the ObjectName with Derby's domain. Key
* type should be first with a short name for the bean, typically the
* class name without the package.
- *
+ *
* @return An identifier that can later be used to unregister the mbean.
+ * @throws StandardException on error
*/
public <T> Object registerMBean(T bean,
Class<T> beanInterface,
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactory.java Thu Jun 14 23:29:38 2018
@@ -38,6 +38,9 @@ public interface ClassFactory {
/**
Add a generated class to the class manager's class repository.
+ @param fullyQualifiedName Full name of the class
+ @param classDump The byte code of the class
+ @return the corresponding generated class
@exception StandardException Standard Derby error policy
*/
@@ -46,12 +49,16 @@ public interface ClassFactory {
/**
Return a ClassInspector object
+
+ @return the class inspector object
*/
public ClassInspector getClassInspector();
/**
Load an application class, or a class that is potentially an application class.
+ @param className The name of the class to load
+ @return the corresponding class object
@exception ClassNotFoundException Class cannot be found, or
a SecurityException or LinkageException was thrown loading the class.
*/
@@ -61,6 +68,8 @@ public interface ClassFactory {
/**
Load an application class, or a class that is potentially an application class.
+ @param classDescriptor Descriptor for class
+ @return the corresponding class
@exception ClassNotFoundException Class cannot be found, or
a SecurityException or LinkageException was thrown loading the class.
*/
@@ -70,6 +79,7 @@ public interface ClassFactory {
/**
Was the passed in class loaded by a ClassManager.
+ @param theClass The class in question
@return true if the class was loaded by a Derby class manager,
false it is was loaded by the system class loader, or another class loader.
*/
@@ -86,6 +96,7 @@ public interface ClassFactory {
/**
Notify the class manager that the classpath has been modified.
+ @param classpath The classpath being modified
@exception StandardException thrown on error
*/
public void notifyModifyClasspath(String classpath) throws StandardException ;
@@ -93,6 +104,8 @@ public interface ClassFactory {
/**
Return the in-memory "version" of the class manager. The version
is bumped everytime the classes are re-loaded.
+
+ @return the version of the class loader
*/
public int getClassLoaderVersion();
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactoryContext.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactoryContext.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactoryContext.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassFactoryContext.java Thu Jun 14 23:29:38 2018
@@ -55,17 +55,25 @@ public abstract class ClassFactoryContex
* transactional nature of the class loading lock.
* Used when the classpath changes or a database
* jar file is installed, removed or replaced.
+ *
+ * @return the lock compatibility space
+ * @throws StandardException on error
*/
public abstract CompatibilitySpace getLockSpace() throws StandardException;
/**
* Get the set of properties stored with this service.
+ *
+ * @return the set of properties stored with this service
+ * @throws StandardException on error
*/
public abstract PersistentSet getPersistentSet() throws StandardException;
/**
Get the mechanism to rad jar files. The ClassFactory
may keep the JarReader reference from the first class load.
+
+ @return the jar file reader
*/
public abstract JarReader getJarReader();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInfo.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInfo.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInfo.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInfo.java Thu Jun 14 23:29:38 2018
@@ -39,6 +39,8 @@ public class ClassInfo implements Instan
/**
Return the name of this class.
+
+ @return the name of this class
*/
public final String getClassName() {
return clazz.getName();
@@ -47,6 +49,8 @@ public class ClassInfo implements Instan
/**
Return the class object for this class.
+ @return the class object for this class
+
*/
public final Class getClassObject() {
@@ -62,6 +66,7 @@ public class ClassInfo implements Instan
@exception InstantiationException Zero arg constructor can not be executed
@exception IllegalAccessException Class or zero arg constructor is not public.
@exception InvocationTargetException Exception throw in zero-arg constructor.
+ @exception NoSuchMethodException Throws on error
*/
public Object getNewInstance()
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInspector.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInspector.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInspector.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/ClassInspector.java Thu Jun 14 23:29:38 2018
@@ -58,6 +58,8 @@ public class ClassInspector
/**
DO NOT USE! use the method in ClassFactory.
+
+ @param cf The class factory
*/
public ClassInspector(ClassFactory cf) {
this.cf = cf;
@@ -71,6 +73,7 @@ public class ClassInspector
* of the named class
*
* @return true if obj is an instanceof className, false if not
+ * @throws ClassNotFoundException on error
*/
public boolean instanceOf(String className, Object obj)
throws ClassNotFoundException
@@ -124,6 +127,7 @@ public class ClassInspector
* @param className The name of the class to test for existence
*
* @return true if the class exists and is accessible, false if not
+ * @throws ClassNotFoundException on error
*/
public boolean accessible(String className)
throws ClassNotFoundException
@@ -204,8 +208,9 @@ public class ClassInspector
* if it has one, otherwise use same object type
* @param isParam Array of booleans telling whether parameter is a ?.
* @param staticMethod Find a static method.
- @param repeatLastParameter If true the last parameter may be repeated any number of times (total count must be greater than one).
+ * @param repeatLastParameter If true the last parameter may be repeated any number of times (total count must be greater than one).
If false the last parameter is matched as usual. This also requires an exact match on the last parameter type.
+ * @param hasVarargs True if a varargs marker is expected
*
* @return A Member representing the matching method. Returns null
* if no such method.
@@ -505,6 +510,11 @@ public class ClassInspector
* Given an implementation of a parameterized interface, return
* the bounds on the type variables. May return null if type resolution
* fails.
+ *
+ * @param parameterizedInterface A generic interface
+ * @param implementation An implementation of the interface
+ * @return the bounds on the type variable
+ * @throws StandardException on error
*/
public Class[][] getTypeBounds( Class parameterizedInterface, Class implementation )
throws StandardException
@@ -537,6 +547,9 @@ public class ClassInspector
/**
* Return true if the method or constructor supports varargs.
+ *
+ * @param member A member method
+ * @return true if it is a varargs method
*/
public boolean isVarArgsMethod( Member member )
{
@@ -553,6 +566,11 @@ public class ClassInspector
* Given an implementation of a parameterized interface, return
* the actual types of the interface type variables.
* May return null or an array of nulls if type resolution fails.
+ *
+ * @param parameterizedType A parameterized type
+ * @param implementation An implementation of that type
+ * @return the actual types of the interface type variables
+ * @throws StandardException on error
*/
public Class<?>[] getGenericParameterTypes(
Class parameterizedType, Class implementation )
@@ -878,6 +896,8 @@ nextMethod: for (int i = 0; i < methods.
and primitive types.
This will attempt to load the class from the application set.
+ @param className Name of class
+ @return the class
@exception ClassNotFoundException Class cannot be found, or
a SecurityException or LinkageException was thrown loading the class.
*/
@@ -1023,6 +1043,7 @@ nextMethod: for (int i = 0; i < methods.
* @param fromClass from class
* @param toClass to class
* @param mixTypes mixing object/primitive types for comparison
+ * @return true if the conversion is possible
**/
protected boolean classConvertableFromTo(Class fromClass, Class toClass, boolean mixTypes) {
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedByteCode.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedByteCode.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedByteCode.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedByteCode.java Thu Jun 14 23:29:38 2018
@@ -34,6 +34,9 @@ public interface GeneratedByteCode {
Initialize the generated class from a context.
Called by the class manager just after
creating the instance of the new class.
+
+ @param context The context to use
+ @throws StandardException on error
*/
public void initFromContext(Context context)
throws StandardException;
@@ -41,16 +44,22 @@ public interface GeneratedByteCode {
/**
Set the Generated Class. Call by the class manager just after
calling initFromContext.
+
+ @param gc A generated class
*/
public void setGC(GeneratedClass gc);
/**
Called by the class manager just after calling setGC().
+
+ @throws StandardException on error
*/
public void postConstructor() throws StandardException;
/**
Get the GeneratedClass object for this object.
+
+ @return a generated class
*/
public GeneratedClass getGC();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedClass.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedClass.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedClass.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedClass.java Thu Jun 14 23:29:38 2018
@@ -33,6 +33,8 @@ public interface GeneratedClass {
/**
Return the name of the generated class.
+
+ @return the class name
*/
public String getName();
@@ -42,6 +44,8 @@ public interface GeneratedClass {
constructor of the represneted class.
(Similar to java.lang.Class.newInstance).
+ @param context Context for the class
+ @return an object of the indicated class
@exception StandardException Standard Derby error policy
*/
@@ -52,6 +56,8 @@ public interface GeneratedClass {
Obtain a handle to the method with the given name
that takes no arguments.
+ @param simpleName Name of the method
+ @return the corresponding generated method
@exception StandardException Standard Derby error policy
*/
public GeneratedMethod getMethod(String simpleName)
@@ -59,6 +65,8 @@ public interface GeneratedClass {
/**
Return the class reload version that this class was built at.
+
+ @return the class loader's version
*/
public int getClassLoaderVersion();
}
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedMethod.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedMethod.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedMethod.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/GeneratedMethod.java Thu Jun 14 23:29:38 2018
@@ -38,6 +38,8 @@ public interface GeneratedMethod {
Returns the value returned by the method.
+ @param ref Reference to a method
+ @return the result of invoking the method
@exception StandardException Standard Derby error policy
*/
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/InstanceGetter.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/InstanceGetter.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/InstanceGetter.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/InstanceGetter.java Thu Jun 14 23:29:38 2018
@@ -28,9 +28,12 @@ public interface InstanceGetter {
/**
Create an instance of a class.
+ @return a new instance of the class
+
@exception InstantiationException Zero arg constructor can not be executed
@exception IllegalAccessException Class or zero arg constructor is not public.
@exception InvocationTargetException Exception throw in zero-arg constructor.
+ @exception NoSuchMethodException Missing method exception
*/
public Object getNewInstance()
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/JarReader.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/JarReader.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/JarReader.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/loader/JarReader.java Thu Jun 14 23:29:38 2018
@@ -32,6 +32,11 @@ public interface JarReader {
/**
* Get the StorageFile for an installed jar file.
+ *
+ * @param schemaName The schema where the jar lives
+ * @param sqlName The unqualified name of the jar
+ * @return the indicated jar file
+ * @throws StandardException on error
*/
StorageFile getJarFile(String schemaName, String sqlName)
throws StandardException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Latch.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Latch.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Latch.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Latch.java Thu Jun 14 23:29:38 2018
@@ -28,16 +28,22 @@ public interface Latch {
/**
Get the compatibility space the latch is held in.
+
+ @return the latch's compatibility space
*/
public CompatibilitySpace getCompatabilitySpace();
/**
- Gte the object the latch is held on.
+ Get the object the latch is held on.
+
+ @return the object the latch is held on
*/
public Lockable getLockable();
/**
Get the qualifier used when the latch was obtained.
+
+ @return the qualifier used when the latch was obtained
*/
public Object getQualifier();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockFactory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockFactory.java Thu Jun 14 23:29:38 2018
@@ -113,18 +113,28 @@ public interface LockFactory extends Pro
/**
Unlock all locks on a group that match the passed in value.
+
+ @param compatibilitySpace A lock space
+ @param group A group
+ @param key The key
*/
public void unlockGroup(CompatibilitySpace compatibilitySpace,
Object group, Matchable key);
/**
Transfer a set of locks from one group to another.
+
+ @param compatibilitySpace A lock space
+ @param oldGroup The source group
+ @param newGroup The target group
*/
public void transfer(CompatibilitySpace compatibilitySpace,
Object oldGroup, Object newGroup);
/**
Returns true if locks held by anyone are blocking anyone else
+
+ @return true if someone is blocked
*/
public boolean anyoneBlocked();
@@ -132,7 +142,9 @@ public interface LockFactory extends Pro
Return true if locks are held in this compatibility space and
this group.
+ @param compatibilitySpace A lock space
@param group handle of group that objects were locked with.
+ @return true if locks matching the arguments are held
*/
public boolean areLocksHeld(CompatibilitySpace compatibilitySpace,
@@ -140,6 +152,10 @@ public interface LockFactory extends Pro
/**
Return true if locks are held in this compatibility space.
+
+ @param compatibilitySpace A lock space
+ @return true if locks matching the arguments are held
+
*/
public boolean areLocksHeld(CompatibilitySpace compatibilitySpace);
@@ -186,6 +202,13 @@ public interface LockFactory extends Pro
/**
Check to see if a specific lock is held.
+
+ @param compatibilitySpace A lock space
+ @param group A group
+ @param ref Something which can be locked
+ @param qualifier The kind of lock
+
+ @return true if the indicated lock is held
*/
public boolean isLockHeld(CompatibilitySpace compatibilitySpace,
Object group, Lockable ref, Object qualifier);
@@ -193,6 +216,8 @@ public interface LockFactory extends Pro
/**
Get the lock timeout in milliseconds. A negative number means that
there is no timeout.
+
+ @return the lock timeout in milliseconds
*/
public int getWaitTimeout();
@@ -211,17 +236,27 @@ public interface LockFactory extends Pro
<BR>
Only one limit may be in place for a group at any time.
@see Limit
+
+ @param compatibilitySpace A lock space
+ @param group A group
+ @param limit A limit for the group
+ @param callback Code to call when the limit is reached
*/
public void setLimit(CompatibilitySpace compatibilitySpace, Object group,
int limit, Limit callback);
/**
Clear a limit set by setLimit.
+
+ @param compatibilitySpace A lock space
+ @param group A group
*/
public void clearLimit(CompatibilitySpace compatibilitySpace, Object group);
/**
Make a virtual lock table for diagnostics.
+
+ @return a virtual lock table
*/
public Enumeration makeVirtualLockTable();
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockOwner.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockOwner.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockOwner.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/LockOwner.java Thu Jun 14 23:29:38 2018
@@ -57,6 +57,8 @@ public interface LockOwner {
* <p>
* Return true if this is a nested owner, e.g., a nested user transaction.
* </p>
+ *
+ * @return true if this is a nested owner, e.g., a nested user transaction
*/
public boolean isNestedOwner();
@@ -64,6 +66,9 @@ public interface LockOwner {
* <p>
* Return true if this owner nests under another owner.
* </p>
+ *
+ * @param other The other lock owner
+ * @return true if this owner nests under another owner
*/
public boolean nestsUnder( LockOwner other );
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Lockable.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Lockable.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Lockable.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/locks/Lockable.java Thu Jun 14 23:29:38 2018
@@ -91,12 +91,18 @@ public interface Lockable {
<P>
Must only be called by the lock manager. Synchronization will be handled
by the lock manager.
+
+ @param lockInfo Latch descriptor
*/
public void lockEvent(Latch lockInfo);
/**
Return true if the requested qualifier is compatible with the already granted
qualifier.
+
+ @param requestedQualifier The desired qualifier
+ @param grantedQualifier The already granted qualifier
+ @return true if the request is compatible
*/
public boolean requestCompatible(Object requestedQualifier, Object grantedQualifier);
@@ -104,6 +110,8 @@ public interface Lockable {
Returns true if any lock request on a Lockable L in a compatibility space CS1 is compatible
with any other lock held on L in CS1.
+ @return if any lock request is allowed
+
*/
public boolean lockerAlwaysCompatible();
@@ -112,6 +120,8 @@ public interface Lockable {
<P>
Must only be called by the lock manager. Synchronization will be handled
by the lock manager.
+
+ @param lockInfo Latch descriptor
*/
public void unlockEvent(Latch lockInfo);
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/monitor/ModuleControl.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/monitor/ModuleControl.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/monitor/ModuleControl.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/monitor/ModuleControl.java Thu Jun 14 23:29:38 2018
@@ -71,6 +71,8 @@ public interface ModuleControl {
as its contents may change underneath it. At least after the complete boot
is completed, the links to all the default sets will be removed.
+ @param create True if the database should be created
+ @param properties Configuration properties
@exception StandardException Module cannot be started.
@see Monitor
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PersistentSet.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PersistentSet.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PersistentSet.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PersistentSet.java Thu Jun 14 23:29:38 2018
@@ -92,6 +92,7 @@ public interface PersistentSet
* is visible as long as the property is not set.
*
* @param key The "key" of the property that is being requested.
+ * @return true if the default property is visible
* @exception StandardException Standard exception policy.
**/
public boolean propertyDefaultIsVisible(String key) throws StandardException;
Modified: db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PropertyFactory.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PropertyFactory.java?rev=1833569&r1=1833568&r2=1833569&view=diff
==============================================================================
--- db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PropertyFactory.java (original)
+++ db/derby/code/trunk/java/org.apache.derby.engine/org/apache/derby/iapi/services/property/PropertyFactory.java Thu Jun 14 23:29:38 2018
@@ -42,7 +42,7 @@ import java.util.Dictionary;
<p>
An PropertyFactory is typically obtained from the Monitor:
- <p>
+ </p>
<blockquote><pre>
// Get the current validation factory.
PropertyFactory af;
@@ -85,16 +85,18 @@ public interface PropertyFactory
throws StandardException;
/**
- * validation a single property
+ * validate a single property
+ *
+ * @param key The property key
+ * @param value The proposed value for the key
+ * @param set The set containing the key/value pair
+ * @throws StandardException if the key/value pair is invalid
*/
public void validateSingleProperty(String key,
Serializable value,
Dictionary set)
throws StandardException;
- /**
-
- */
public Serializable doValidateApplyAndMap(TransactionController tc,
String key, Serializable value,
Dictionary d, boolean dbOnlyProperty)
@@ -108,6 +110,12 @@ public interface PropertyFactory
The caller must run this in a block synchronized on this
to serialize validations with changes to the set of
property callbacks
+
+ @param key The property key
+ @param value The value to be bound to the key
+ @param set The property set for this key
+ @return a serializable
+ @throws StandardException if the key/value pair is invalid
*/
public Serializable doMap(String key,
Serializable value,