You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ojb-dev@db.apache.org by br...@apache.org on 2004/03/17 02:43:19 UTC
cvs commit: db-ojb/src/java/org/apache/ojb/otm/swizzle Swizzling.java
brianm 2004/03/16 17:43:19
Modified: src/java/org/apache/ojb/otm Kit.java OTMConnection.java
src/java/org/apache/ojb/otm/swizzle Swizzling.java
Log:
Expanding javadocs
Revision Changes Path
1.4 +25 -2 db-ojb/src/java/org/apache/ojb/otm/Kit.java
Index: Kit.java
===================================================================
RCS file: /home/cvs/db-ojb/src/java/org/apache/ojb/otm/Kit.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Kit.java 11 Mar 2004 18:16:19 -0000 1.3
+++ Kit.java 17 Mar 2004 01:43:18 -0000 1.4
@@ -24,25 +24,48 @@
import org.apache.ojb.otm.swizzle.Swizzling;
/**
- *
- * The interface to a configuration Kit
+ * The Kit provides the point of entry for any OTM client
*
* @author <a href="mailto:mattbaird@yahoo.com">Matthew Baird</a>
*/
public interface Kit
{
+ /**
+ * Acquire an open OTMConnection
+ *
+ * @param pbKey
+ * @return
+ */
OTMConnection acquireConnection(PBKey pbKey);
+ /**
+ * Obtain the transaction this connection is bound to
+ */
Transaction getTransaction(OTMConnection conn);
+ /**
+ * @todo document
+ */
Swizzling getSwizzlingStrategy();
+ /**
+ * @todo document
+ */
LockWaitStrategy getLockWaitStrategy();
+ /**
+ * @todo document
+ */
LockMap getLockMap();
+ /**
+ * @todo document
+ */
ObjectCopyStrategy getCopyStrategy(Identity oid);
+ /**
+ * @todo document
+ */
boolean isImplicitLockingUsed();
}
1.19 +7 -0 db-ojb/src/java/org/apache/ojb/otm/OTMConnection.java
Index: OTMConnection.java
===================================================================
RCS file: /home/cvs/db-ojb/src/java/org/apache/ojb/otm/OTMConnection.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- OTMConnection.java 11 Mar 2004 18:16:19 -0000 1.18
+++ OTMConnection.java 17 Mar 2004 01:43:18 -0000 1.19
@@ -48,7 +48,14 @@
public void makePersistent(Object object)
throws LockingException;
+ /**
+ * Obtain the Transaction this connection is associated with
+ */
public Transaction getTransaction();
+
+ /**
+ * Associate this connection with a given transaction.
+ */
public void setTransaction(Transaction tx);
/**
1.7 +4 -0 db-ojb/src/java/org/apache/ojb/otm/swizzle/Swizzling.java
Index: Swizzling.java
===================================================================
RCS file: /home/cvs/db-ojb/src/java/org/apache/ojb/otm/swizzle/Swizzling.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Swizzling.java 11 Mar 2004 18:16:21 -0000 1.6
+++ Swizzling.java 17 Mar 2004 01:43:19 -0000 1.7
@@ -17,6 +17,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+/**
+ * @todo document
+ */
public interface Swizzling
{
---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org