You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jdo-dev@db.apache.org by "Craig Russell (JIRA)" <ji...@apache.org> on 2005/12/07 01:48:12 UTC

[jira] Updated: (JDO-117) PM.newObjectIdInstance javadoc description is inadequate to describe the usage

     [ http://issues.apache.org/jira/browse/JDO-117?page=all ]

Craig Russell updated JDO-117:
------------------------------

    Fix Version: JDO 2 beta

> PM.newObjectIdInstance javadoc description is inadequate to describe the usage
> ------------------------------------------------------------------------------
>
>          Key: JDO-117
>          URL: http://issues.apache.org/jira/browse/JDO-117
>      Project: JDO
>         Type: Improvement
>   Components: api20
>     Reporter: Andy Jefferson
>     Assignee: Craig Russell
>     Priority: Minor
>      Fix For: JDO 2 beta

>
> People often rely on javadocs to decide how to use a method (yes, I know they also have the spec). If someone looks at the javadoc for PersistenceManager.newObjectIdInstance(Class, Object) they have
> "pcClass - the Class of the persistence-capable instance
> key - the value of the key field for single-field identity."
> This doesn't tell them that the "key" should be a String (the result of toString() on the id) when using datastore identity or application identity (when not SingleFieldIdentity) and should only be Long/Integer/Byte/Char/etc when using SingleFieldIdentity.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira