Apache/openjpa
1
0
Fork 0
mirror of https://github.com/apache/openjpa.git synced 2025-02-20 17:05:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

more javadoc fixes

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/incubator/openjpa/trunk@421775 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Patrick Linskey 2006-07-14 00:47:40 +00:00
parent 7cf69d8bcc
commit e27f636729
20 changed files with 30 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
openjpa-kernel/src/main/java/org/apache/openjpa/enhance/PCEnhancer.java
View File

@ -2112,7 +2112,7 @@ public class PCEnhancer {
/**
* Adds a custom writeObject method that delegates to the
* {@link ObjectInputStream#writeObject} method,
* {@link ObjectOutputStream#defaultWriteObject} method,
* but only after calling the internal <code>pcSerializing</code> method.
*/
private void modifyWriteObjectMethod(BCMethod method, boolean full) {

2
openjpa-kernel/src/main/java/org/apache/openjpa/event/TransactionEvent.java
View File

@ -92,7 +92,7 @@ public class TransactionEvent
/**
* Constructor.
*
* @param pm the event source
* @param broker the event source
* @param type the event type
* @param objs transactional objects
* @param addClss classes of added instances

2
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/AbstractLockManager.java
View File

@ -50,7 +50,7 @@ public abstract class AbstractLockManager
}
/**
* Delegates to {@link #lock} with each element of the collection.
* Delegates to {@link LockManager#lock} with each element of the collection
*/
public void lockAll(Collection sms, int level, int timeout,
Object context) {

2
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/FetchConfiguration.java
View File

@ -225,8 +225,6 @@ public interface FetchConfiguration
/**
* Return the root instances.
*
* @return
*/
public Set getRootClasses();

1
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/FetchStateImpl.java
View File

@ -114,7 +114,6 @@ public class FetchStateImpl
* Get the recusion depth for the given field.
*
* @param fm is the field to look for
* @param depths is the map of field to integer depth.
* @return 0 if the field does not appear in the given map.
*/
protected int getRecursionDepth(FieldMetaData fm) {

4
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/FindCallbacks.java
View File

@ -24,8 +24,8 @@ package org.apache.openjpa.kernel;
public interface FindCallbacks {
/**
* Process find argument. Throw proper {@link OpenJPAException}
* for illegal value.
* Process find argument. Throw proper
* {@link org.apache.openjpa.util.OpenJPAException} for illegal value.
*
* @return the id to look up, or null to ignore this argument
*/

4
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/LockManager.java
View File

@ -60,8 +60,8 @@ public interface LockManager
* to the persistence context, if any; lock managers
* specific to a certain back end may be able to take
* advantage of this; others should ignore it
* @throws LockException if a lock cannot be obtained in the
* given number of milliseconds
* @throws org.apache.openjpa.util.LockException if a lock cannot be
* obtained in the given number of milliseconds
* @see OpenJPAStateManager#setLock
*/
public void lock(OpenJPAStateManager sm, int level, int timeout,

4
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/OpCallbacks.java
View File

@ -40,8 +40,8 @@ public interface OpCallbacks {
public static final int ACT_RUN = 2 << 1;
/**
* Process operation argument. Throw proper {@link OpenJPAException}
* for illegal value.
* Process operation argument. Throw proper
* {@link org.apache.openjpa.util.OpenJPAException} for illegal value.
*
* @param op the operation constant
* @param arg the object passed to the operation

4
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/PCState.java
View File

@ -230,7 +230,7 @@ public class PCState
/**
* Perform any actions necesssary and return the proper lifecycle state
* on a call to {@link Broker#makeNontransactional} with the given
* on a call to {@link StoreContext#nontransactional} with the given
* instance. Returns the <code>this</code> pointer by default.
*/
PCState nontransactional(StateManagerImpl context) {
@ -239,7 +239,7 @@ public class PCState
/**
* Perform any actions necesssary and return the proper lifecycle state
* on a call to {@link Broker#makeNontransactional} with the given
* on a call to {@link StoreContext#nontransactional} with the given
* instance. Returns the <code>this</code> pointer by default.
*/
PCState transactional(StateManagerImpl context) {

7
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/StoreContext.java
View File

@ -148,8 +148,9 @@ public interface StoreContext {
/**
* Return an iterator over all instances of the given type. The iterator
* should be closed with {@link ImplHelper#close} when no longer needed.
* This method delegates to {@link StoreManager#executeExtent}.
* should be closed with {@link org.apache.openjpa.util.ImplHelper#close}
* when no longer needed. This method delegates to
* {@link StoreManager#executeExtent}.
*/
public Iterator extentIterator(Class cls, boolean subs,
FetchConfiguration fetch, boolean ignoreChanges);
@ -383,7 +384,7 @@ public interface StoreContext {
* will have to flush instances of objects for each class of object
* modified during the transaction. A side benefit of large transaction
* mode is that smaller update messages can be used for
* {@link RemoteCommitEvent}s. Defaults to false.
* {@link org.apache.openjpa.event.RemoteCommitEvent}s. Defaults to false.
*
* @since 3.4
*/

2
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/StoreQuery.java
View File

@ -231,7 +231,7 @@ public interface StoreQuery
* in memory. If this exeuctor's parent query supports executors on
* abstract or interface classes, this method will not be used.
*
* @see StoreQuery#supportsAbstractExecutor
* @see StoreQuery#supportsAbstractExecutors
*/
public Object getOrderingValue(StoreQuery q, Object[] params,
Object resultObject, int orderIndex);

1
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/exps/AbstractExpressionBuilder.java
View File

@ -74,7 +74,6 @@ public abstract class AbstractExpressionBuilder {
* Constructor.
*
* @param factory the expression factory to use
* @param meta candidate class metadata
* @param resolver used to resolve variables, parameters, and class
* names used in the query
*/

4
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/exps/AggregateListener.java
View File

@ -53,8 +53,8 @@ public interface AggregateListener
* @param candidates the candidate objects being evaluated
* @param ctx the persistence context
* @return the value of the aggregate
* @throws UserException if this aggregate does not support
* in-memory operation
* @throws org.apache.openjpa.util.UserException if this aggregate does not
* support in-memory operation
*/
public Object evaluate(Collection args, Class[] argClasses,
Collection candidates, StoreContext ctx);

4
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/exps/FilterListener.java
View File

@ -69,8 +69,8 @@ public interface FilterListener
* @return the value of the extension for this candidate; if
* this extension is an expression, this method should
* return {@link Boolean#TRUE} or {@link Boolean#FALSE}
* @throws UserException if this extension does not support
* in-memory operation
* @throws org.apache.openjpa.util.UserException if this extension does not
* support in-memory operation
*/
public Object evaluate(Object target, Class targetClass, Object[] args,
Class[] argClasses, Object candidate, StoreContext ctx);

2
openjpa-kernel/src/main/java/org/apache/openjpa/kernel/jpql/JPQLExpressionBuilder.java
View File

@ -1577,7 +1577,7 @@ class JPQLExpressionBuilder
/**
* Debugging method.
*
* @see dump(java.io.PrintStream,String)
* @see #dump(java.io.PrintStream,String)
*/
public void dump(String prefix) {
dump(System.out, prefix);

3
openjpa-kernel/src/main/java/org/apache/openjpa/meta/FetchGroup.java
View File

@ -50,7 +50,7 @@ public class FetchGroup
/**
* Supply immutable name.
*
* @param must not by null or empty.
* @param name must not by null or empty.
*/
FetchGroup(ClassMetaData cm, String name) {
super();
@ -94,7 +94,6 @@ public class FetchGroup
* @param fg
* @param recurse if true then recursively checks within the included
* fecth groups. Otherwise just checks within direct includes.
* @return
*/
public boolean includes(FetchGroup fg, boolean recurse) {
if (_includes == null)

3
openjpa-kernel/src/main/java/org/apache/openjpa/util/ImplHelper.java
View File

@ -251,7 +251,6 @@ public class ImplHelper {
*
* @param type the class to test
* @return true if the class is manageable.
* @param conf the configuration that defines the current context
*/
public static boolean isManagedType(Class type) {
return PersistenceCapable.class.isAssignableFrom(type);
@ -265,5 +264,5 @@ public class ImplHelper {
*/
public static boolean isManageable(Object instance) {
return instance instanceof PersistenceCapable;
}
}
}

4
openjpa-lib/src/main/java/org/apache/openjpa/lib/util/StringDistance.java
View File

@ -111,7 +111,7 @@ public class StringDistance {
* @see #getLevenshteinDistance
*/
public static String getClosestLevenshteinDistance(String str,
Collection candidates, int threshhold) {
Collection candidates, int threshold) {
if (candidates == null || candidates.isEmpty())
return null;
@ -128,7 +128,7 @@ public class StringDistance {
}
// return the lowest close string only if we surpass the threshhold
if (minValue <= threshhold)
if (minValue <= threshold)
return minString;
else
return null;

2
openjpa-lib/src/main/java/org/apache/openjpa/lib/util/concurrent/ConcurrentHashMap.java
View File

@ -287,7 +287,7 @@ public class ConcurrentHashMap extends AbstractMap
* Returns <tt>true</tt> if this map contains a mapping for the
* specified key.
*
* @param keyThe key whose presence in this map is to be tested
* @param key The key whose presence in this map is to be tested
* @return <tt>true</tt> if this map contains a mapping for the specified
* key.
*/

8
openjpa-lib/src/test/java/org/apache/openjpa/lib/test/AbstractTestCase.java
View File

@ -548,9 +548,9 @@ public abstract class AbstractTestCase extends TestCase {
* error message
* @param serialCount the number of times to run the method
* serially before spawning threads.
* @param thread the number of Threads to run in
* @param threads the number of Threads to run in
* @param iterations the number of times the method should
* @param runnner the VolatileRunnable that will execute
* @param runner the VolatileRunnable that will execute
* the actual test from within the Thread.
* @throws ThreadingException if an errors occur in
* any of the Threads. The actual exceptions
@ -766,8 +766,8 @@ public abstract class AbstractTestCase extends TestCase {
* <p/>
* <strong>Warning</strong> this method should be used sparingly,
* and only when you expect that a timeout will <strong>not</strong>
* occur. It utilized the deprecated {@link Thread.stop} and
* {@link Thread.interrupt} methods, which can leave monitors in an
* occur. It utilized the deprecated {@link Thread#stop()} and
* {@link Thread#interrupt} methods, which can leave monitors in an
* invalid state. It is only used because it provides more
* meaningful information than just seeing that the entire autobuild
* timed out.