Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 319256

Summary:

Some constants in PersistenceUnitProperties are missing JavaDoc

Product:

z_Archived

Reporter:

Adrian Goerler <adrian.goerler>

Component:

Eclipselink

Assignee:

Nobody - feel free to take it <nobody>

Status:

RESOLVED FIXED

QA Contact:

Severity:

trivial

Priority:

CC:

david.minsky, tom.ware

Version:

unspecified

Target Milestone:

---

Hardware:

OS:

Windows XP

Whiteboard:

simple_fix

Attachments:

Description	Flags
Proposed JavaDoc and Constructor changes to PersistenceUnitProperties	none
Proposed JavaDoc changes to PersistenceUnitProperties (V2)	none

Description Adrian Goerler

2010-07-08 07:30:07 EDT

The following constants in the class PersistenceUnitProperties are missing JavaDoc:

CREATE_ONLY, DROP_AND_CREATE, NONE, APP_LOCATION, CREATE_JDBC_DDL_FILE, DROP_JDBC_DDL_FILE, DEFAULT_APP_LOCATION, DEFAULT_CREATE_JDBC_FILE_NAME, DEFAULT_DROP_JDBC_FILE_NAME, JAVASE_DB_INTERACTION, DDL_SQL_SCRIPT_GENERATION, DDL_DATABASE_GENERATION, DDL_BOTH_GENERATION, DEFAULT_DDL_GENERATION_MODE.

Moreover, the class should have a private (default) constructor to prevent instantiation.

Comment 1 Tom Ware

2010-08-09 13:52:53 EDT

Setting target and priority.  See the following page for details of the meanings of these fields:

http://wiki.eclipse.org/EclipseLink/Development/Bugs/Guidelines

Comment 2 David Minsky

2011-02-23 14:29:21 EST

Created attachment 189629 [details]
Proposed JavaDoc and Constructor changes to PersistenceUnitProperties

Comment 3 Adrian Goerler

2011-02-24 02:17:18 EST

Looks good to me and will be quite helpful. I have two two minor comments:

APP_LOCATION: "root of the working directory" -> shouldn't it rather be "the working directory"?

For all parameter values CREATE_ONLY, ...:  I think it should rather read

"The parameter value <code>"create-tables"</code>"

or just

"The value <code>"create-tables"</code>"

(The property "eclipselink.ddl-generation" has a parameter, which may have the value "create-tables").

Comment 4 David Minsky

2011-02-24 11:59:19 EST

Created attachment 189718 [details]
Proposed JavaDoc changes to PersistenceUnitProperties (V2)

Updated changes based on community feedback: (v2)

- remove private default constructor, to be consistent with existing classes using this pattern
- reword JavaDoc comments, and add additional consistency between properties and property values

Comment 5 David Minsky

2011-02-25 10:53:54 EST

Changes checked into trunk (2.3) at revision 9032

Comment 6 Eclipse Webmaster

2022-06-09 10:26:57 EDT

The Eclipselink project has moved to Github: https://github.com/eclipse-ee4j/eclipselink