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 mi...@apache.org on 2005/04/22 20:21:22 UTC
svn commit: r164264 - in
/incubator/derby/code/trunk/java/engine/org/apache/derby: catalog/types/
database/ iapi/db/ iapi/services/cache/
Author: mikem
Date: Fri Apr 22 11:21:21 2005
New Revision: 164264
URL: http://svn.apache.org/viewcvs?rev=164264&view=rev
Log:
javadoc warning fixes.
Modified:
incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/types/TypeDescriptorImpl.java
incubator/derby/code/trunk/java/engine/org/apache/derby/database/Database.java
incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/Database.java
incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/PropertyInfo.java
incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheFactory.java
incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheManager.java
incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/Cacheable.java
incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/ClassSize.java
incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/SizedCacheable.java
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/types/TypeDescriptorImpl.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/types/TypeDescriptorImpl.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/types/TypeDescriptorImpl.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/types/TypeDescriptorImpl.java Fri Apr 22 11:21:21 2005
@@ -262,7 +262,7 @@
/**
Compare if two TypeDescriptors are exactly the same
- @param typeDescriptor the dataTypeDescriptor to compare to.
+ @param object the dataTypeDescriptor to compare to.
*/
public boolean equals(Object object)
{
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/database/Database.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/database/Database.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/database/Database.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/database/Database.java Fri Apr 22 11:21:21 2005
@@ -47,7 +47,7 @@
* <I>IBM Corp. reserves the right to change, rename, or
* remove this interface at any time.</I>
- @see Factory
+ @see org.apache.derby.iapi.db.Factory
*/
public interface Database
{
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/Database.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/Database.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/Database.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/Database.java Fri Apr 22 11:21:21 2005
@@ -68,7 +68,6 @@
* so it can implement the DatabaseMetaData.getURL() method.
*
* @param user The UserID of the user getting the connection
- * @param unicode True means unicode codeset, false means ASCII codeset
* @param drdaID The drda id of the connection (from network server)
* @param dbname The database name
*
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/PropertyInfo.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/PropertyInfo.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/PropertyInfo.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/db/PropertyInfo.java Fri Apr 22 11:21:21 2005
@@ -150,7 +150,6 @@
*
* @param schemaName The name of the schema that the conglomerate is in.
* @param conglomerateName The name of the conglomerate.
- * @param conglomerateType TABLE or INDEX.
*
* @return Properties The Properties associated with the specified conglomerate.
* (An empty Properties is returned if the conglomerate does not exist.)
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheFactory.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheFactory.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheFactory.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheFactory.java Fri Apr 22 11:21:21 2005
@@ -31,7 +31,6 @@
@param holderFactory The factory for the objects that are to be cached.
@param name The name of the cache
- @param initParam The object passed to each holder object's initParameter() method.
@param initialSize The number of initial holder objects that will be created
@param maximumSize The maximum number of objects the cache will hold
@@ -44,9 +43,8 @@
Create a cache that uses the class represented by holderClass as
the holder class. This holderClass must implement Cacheable.
- @param holderClass The Class object representing the holder class.
+ @param holderFactory The Class object representing the holder class.
@param name The name of the cache
- @param initParam The object passed to each holder object's initParameter() method.
@param initialSize The number of initial holder objects that will be created
@param maximumSize The maximum total size of the objects that the cache will hold
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheManager.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheManager.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheManager.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/CacheManager.java Fri Apr 22 11:21:21 2005
@@ -44,6 +44,8 @@
public void resize( long newSize) throws StandardException;
/**
+ Find an object in the cache.
+ <p>
Find an object in the cache that matches the key provided using the equals()
method, i.e. the return Cacheable will have getIdentifier.equals(key) true.
If the object does not exist in the cache it will be added by one of:
@@ -82,6 +84,8 @@
public Cacheable find(Object key) throws StandardException;
/**
+ Find an object in the cache.
+ <p>
Find an object in the cache that matches the key provided using the equals()
method, i.e. the return Cacheable will have getIdentifier.equals(key) true.
If a matching object does not exist in the cache, null is returned.
@@ -119,7 +123,7 @@
* of find() or findCached. If the entry has been replaced then this method
* does nothing.
*
- * @param key the key of the used entry.
+ * @param keys the key of the used entry.
*/
public void setUsed( Object[] keys);
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/Cacheable.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/Cacheable.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/Cacheable.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/Cacheable.java Fri Apr 22 11:21:21 2005
@@ -58,6 +58,8 @@
public interface Cacheable {
/**
+ Set the identity of the object.
+ <p>
Set the identity of the object to represent an item that already exists,
e.g. an existing container.
The object will be in the No Identity state,
@@ -86,6 +88,8 @@
public Cacheable setIdentity(Object key) throws StandardException;
/**
+ Create a new item.
+ <p>
Create a new item and set the identity of the object to represent it.
The object will be in the No Identity state,
ie. it will have just been created or clearIdentity() was just called.
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/ClassSize.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/ClassSize.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/ClassSize.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/ClassSize.java Fri Apr 22 11:21:21 2005
@@ -191,7 +191,7 @@
*
* @see #estimateBaseFromCoefficients
* @see #getSizeCoefficients
- * @see ClassSizeCrawler
+ * see org.apache.derbyBuild.ClassSizeCrawler
*/
public static int estimateBaseFromCatalog( Class cls)
{
@@ -236,7 +236,7 @@
*
* @see #estimateBaseFromCoefficients
* @see #getSizeCoefficients
- * @see ClassSizeCrawler
+ * see org.apache.derbyBuild.ClassSizeCrawler
*/
public static int estimateAndCatalogBase( Class cls)
{
@@ -254,7 +254,7 @@
* 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 ClassSizeCrawler
+ * see org.apache.derbyBuild.ClassSizeCrawler
* @see #estimateBaseFromCatalog
*/
public static int estimateBase( Class cl)
Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/SizedCacheable.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/SizedCacheable.java?rev=164264&r1=164263&r2=164264&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/SizedCacheable.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/cache/SizedCacheable.java Fri Apr 22 11:21:21 2005
@@ -27,7 +27,6 @@
* CacheManagers constructed with the CacheFactory use regulate the total number of cache entries.
*
* @see Cacheable
- * @see SizedCacheableFactory
* @see CacheFactory
*
* @author Jack Klebanoff