arminw 2005/12/14 04:18:44
Modified: src/java/org/apache/ojb/broker Tag: OJB_1_0_RELEASE
Identity.java
Log:
javadoc update
Revision Changes Path
No revision
No revision
1.36.2.13 +25 -9 db-ojb/src/java/org/apache/ojb/broker/Identity.java
Index: Identity.java
===================================================================
RCS file: /home/cvs/db-ojb/src/java/org/apache/ojb/broker/Identity.java,v
retrieving revision 1.36.2.12
retrieving revision 1.36.2.13
diff -u -r1.36.2.12 -r1.36.2.13
--- Identity.java 13 Dec 2005 18:21:24 -0000 1.36.2.12
+++ Identity.java 14 Dec 2005 12:18:44 -0000 1.36.2.13
@@ -49,15 +49,14 @@
* an array of all primary key value objects
* </li>
* <li>
- * a flag which indicates whether this is an <em>transient Identity</em>
- * (identity of a non-persisted object) or <em>persisted Identity</em>
(identity object
- * of a persisted object).
+ * a flag which indicates whether this is a <em>transient Identity</em>
+ * (identity of a non-persistent, "new" object) or a <em>persistent
Identity</em> (identity object
+ * of a persistent, "already written to datastore" object).
* </li>
* </ul>
* <p>
- * If in the metadata of an persistent capable object class the attribute
<em>autoincrement</em>
- * is set true, new primary key values will be automatic assigned to the
given object passed as
- * constructor argument.
+ * To create <code>Identity</code> objects it's strongly recommended to use
the [EMAIL PROTECTED] IdentityFactory}, because
+ * in future releases of OJB the <code>Identity</code> constructors will be
no longer reachable or forbidden to use.
* </p>
* <p>
* NOTE: An <em>Identity</em> object must be unique
@@ -119,8 +118,11 @@
}
/**
- * Creates an em from a class and the objects primary key values.
+ * For internal use only!. Creates an em from a class and the objects
primary key values.
* used for the definition of proxies.
+ * <br/>
+ * OJB user have to use [EMAIL PROTECTED] IdentityFactory} to create
object identity.
+ *
*
* @param realClass the concrete class of the object, or null if not
known.
* @param topLevel the highest persistence-capable class or
@@ -138,8 +140,10 @@
}
/**
- * creates an Identity from a class and the objects primary key values.
+ * For internal use only! Creates an Identity from a class and the
objects primary key values.
* used for the definition of proxies.
+ * <br/>
+ * OJB user have to use [EMAIL PROTECTED] IdentityFactory} to create
object identity.
*
* @param realClass the concrete class of the object, or null if not
known.
* @param topLevel the highest persistence-capable class or
@@ -155,12 +159,24 @@
checkForPrimaryKeys(null);
}
+ /**
+ * For internal use! Use [EMAIL PROTECTED] IdentityFactory} to create
object identity.
+ * <br/>
+ * OJB user have to use [EMAIL PROTECTED] IdentityFactory} to create
object identity.
+ *
+ */
public Identity(final Object objectToIdentitify, final PersistenceBroker
targetBroker)
{
this.isTransient = IS_PERMANENT;
init(objectToIdentitify, targetBroker, null);
}
+ /**
+ * For internal use! Use [EMAIL PROTECTED] IdentityFactory} to create
object identity.
+ * <br/>
+ * OJB user have to use [EMAIL PROTECTED] IdentityFactory} to create
object identity.
+ *
+ */
public Identity(final Object objectToIdentitify, final PersistenceBroker
targetBroker, final ClassDescriptor cld)
{
this.isTransient = IS_PERMANENT;
@@ -453,4 +469,4 @@
eol + "object to identify: " + objectToIdentify);
}
}
-}
+}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
