Add public constructor for JDOHelper

• Key: JDO-444
• Type: New Feature
• Status: Resolved
• Resolution: Fixed
• Priority: Major
• Assignee: Craig Russell
• Reporter: Michelle Caisse
• Component/s: api2, api2-legacy, specification
• Fix Version/s: JDO 2 maintenance release 1

Description

In Chapter 8, add after class JDOHelper {public JDOHelper(); For some usage patterns, an instance of JDOHelper on which to invoke methods is preferable to the use of static methods. For this purpose, a public constructor is provided.

Comments

[Craig Russell]

Please review this patch.

[Craig Russell]

Here is the spec update for review.

package javax.jdo;
class JDOHelper {
/* Some applications might prefer to use an instance
* method instead of static methods.
*/
public JDOHelper();

[Craig Russell]

Add to the specification text:

The instance returned by the constructor is thread safe. It can be used from any number of threads without concern for synchronization.

[Michael Bouschen]

The patch and the spec updates look good. Just one comment: above you added the javadoc for the spec update. I propose to use the same javadoc in the implementation in api2 and api2-legacy.

[Craig Russell]

Please review this patch. I've incorporated the getInstance change and added Javadoc.

The patch JDOHelper.diff looks good!

Just one comment: how about adding a comment to the test methods testConstructor and testGetInstance saying that the purpose of the test is calling the JDOHelper methods on the instance and making sure they do not throw an exception.

[Craig Russell]

Thanks for the review.

I've added javadoc and @since 2.1 to the two classes. I think it's done.

[Michael Bouschen]

Looks good!

[Craig Russell]

svn commit -m "JDO-444 Added public constructor and getInstance method to JDOHelper" api20/src/java/javax/jdo/JDOHelper.java
Sending api20/src/java/javax/jdo/JDOHelper.java
Transmitting file data .
Committed revision 509807.