Skip to content

Commit 1a5a538

Browse files
committed
Fix Javadoc errors blocking release build
1 parent 47975a3 commit 1a5a538

7 files changed

Lines changed: 24 additions & 38 deletions

File tree

source/java/src/org/lucee/extension/orm/hibernate/HibernateCaster.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -429,10 +429,10 @@ public static Object toHibernateValue(PageContext pc, Object value, String type)
429429

430430
/**
431431
* translate CFMl specific types to Hibernate/SQL specific types
432-
*
433-
* @param engine
432+
*
434433
* @param ci
435434
* @param value
435+
* @param isArray
436436
* @return
437437
* @throws PageException
438438
*/
@@ -442,10 +442,10 @@ public static Object toSQL(ColumnInfo ci, Object value, RefBoolean isArray) thro
442442

443443
/**
444444
* translate CFMl specific types to Hibernate/SQL specific types
445-
*
446-
* @param engine
445+
*
447446
* @param type
448447
* @param value
448+
* @param isArray
449449
* @return
450450
* @throws PageException
451451
*/
@@ -457,10 +457,10 @@ public static Object toSQL(Type type, Object value, RefBoolean isArray) throws P
457457

458458
/**
459459
* translate CFMl specific type to SQL specific types
460-
*
461-
* @param engine
460+
*
462461
* @param sqlType
463462
* @param value
463+
* @param isArray
464464
* @return
465465
* @throws PageException
466466
*/

source/java/src/org/lucee/extension/orm/hibernate/functions/EntityNew.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ public static Object call( PageContext pc, String name, Struct properties ) thro
6262

6363
/**
6464
*
65-
* @TODO: Move this to a reusable EntityPopulator? Do we populate entities anywhere else?
66-
* @TODO: Either drop ignoreNotExisting argument, or implement a 'true' condition. This is always `false`, currently.
65+
* TODO: Move this to a reusable EntityPopulator? Do we populate entities anywhere else?
66+
* TODO: Either drop ignoreNotExisting argument, or implement a 'true' condition. This is always {@code false}, currently.
6767
*
6868
* @param pc Lucee PageContext
6969
* @param c The new entity Component

source/java/src/org/lucee/extension/orm/hibernate/mapping/CFConstants.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,8 @@ public static boolean isValidValue( String value ) {
222222
}
223223

224224
/**
225-
* @TODO: Move this into some CFConstants class, or somewhere that both HBMCreator and HibernateCaster can reference it.
226-
* @TODO: @nextMajorRelease, Migrate to Map.of() or Map.ofEntries in Java 9+
225+
* TODO: Move this into some CFConstants class, or somewhere that both HBMCreator and HibernateCaster can reference it.
226+
* TODO: @nextMajorRelease, Migrate to Map.of() or Map.ofEntries in Java 9+
227227
*/
228228
public static class Relationships {
229229

source/java/src/org/lucee/extension/orm/hibernate/mapping/HBMCreator.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,22 @@ private HBMCreator() {}
4747
/**
4848
* Hibernate DOCTYPE mapping ID
4949
*
50-
* @see https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#schema-generation-database-objects
50+
* @see <a href="https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#schema-generation-database-objects">Hibernate User Guide</a>
5151
*/
5252
public static final String HIBERNATE_3_PUBLIC_ID = "-//Hibernate/Hibernate Mapping DTD 3.0//EN";
5353

5454
/**
5555
* Hibernate doctype reference
5656
*
57-
* @see https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#schema-generation-database-objects
57+
* @see <a href="https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#schema-generation-database-objects">Hibernate User Guide</a>
5858
*/
5959
// public static final String HIBERNATE_3_SYSTEM_ID = "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd";
6060
public static final String HIBERNATE_3_SYSTEM_ID = "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd";
6161

6262
/**
6363
* Full XML doctype for Hibernate mappings
6464
*
65-
* @see https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#schema-generation-database-objects
65+
* @see <a href="https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#schema-generation-database-objects">Hibernate User Guide</a>
6666
*/
6767
public static final String HIBERNATE_3_DOCTYPE_DEFINITION = "<!DOCTYPE hibernate-mapping PUBLIC \""
6868
+ HIBERNATE_3_PUBLIC_ID + "\" \"" + HIBERNATE_3_SYSTEM_ID + "\">";
@@ -1962,7 +1962,7 @@ public static String loadMapping(Component cfc) throws PageException, IOExceptio
19621962
* since the epoch (00:00:00 GMT, January 1, 1970), or <code>0L</code> if the file does not exist or if an
19631963
* I/O error occurs
19641964
*
1965-
* @see lucee.commons.io.res.Resource#lastModified();
1965+
* @see lucee.commons.io.res.Resource#lastModified()
19661966
*/
19671967
public static long getMappingLastModified(Component cfc) {
19681968
Resource res = getMappingResource(cfc);
@@ -1987,7 +1987,7 @@ public static Resource getMappingResource(Component cfc) {
19871987
}
19881988

19891989
/**
1990-
* Get the opening of a Hibernate mapping XML file, including <xml> tag and DOCTYPE declaration
1990+
* Get the opening of a Hibernate mapping XML file, including {@code <?xml?>} tag and DOCTYPE declaration
19911991
*/
19921992
public static String getXMLOpen() {
19931993
StringBuilder xml = new StringBuilder();
@@ -1998,14 +1998,14 @@ public static String getXMLOpen() {
19981998
}
19991999

20002000
/**
2001-
* Strip the open/close tags (i.e. `<xml>`, `<!DOCTYPE>`, `<hibernate-mapping>`) from an hbm.xml file.
2001+
* Strip the open/close tags (i.e. {@code <?xml?>}, {@code <!DOCTYPE>}, {@code <hibernate-mapping>}) from an hbm.xml file.
20022002
* <p>
2003-
* Useful for assembling multiple entities into a single `<hibernate-mapping>` element for sending to Hibernate.
2003+
* Useful for assembling multiple entities into a single {@code <hibernate-mapping>} element for sending to Hibernate.
20042004
*
20052005
* @param xml
20062006
* XML string from which to strip open and close tags
20072007
*
2008-
* @return an XML string with the DOCTYPE, `<xml>` and `<hibernate-mapping>` elements removed
2008+
* @return an XML string with the DOCTYPE, {@code <?xml?>} and {@code <hibernate-mapping>} elements removed
20092009
*/
20102010
public static String stripXMLOpenClose(String xml) {
20112011
return xml.replaceAll("<\\?xml[^>]+>", "").replaceAll("<!DOCTYPE[^>]+>", "").replaceAll("</?hibernate-mapping>",

source/java/src/org/lucee/extension/orm/hibernate/util/CommonUtil.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ public static boolean isStruct(Object obj) {
496496
* Blatantly copied from Lucee core because it's not in the Lucee loader, so we don't have access to run it without
497497
* reflection.
498498
*
499-
* @link https://github.com/lucee/Lucee/blob/6.0/core/src/main/java/lucee/runtime/op/Decision.java#L964
499+
* @see <a href="https://github.com/lucee/Lucee/blob/6.0/core/src/main/java/lucee/runtime/op/Decision.java#L964">Lucee core Decision.java</a>
500500
*
501501
* @param o
502502
* Value to compare
@@ -1039,7 +1039,7 @@ public static Calendar toCalendar(DateTime date, TimeZone timeZone, Locale local
10391039
* <p>
10401040
* Blatantly copied from the Lucee core, since we don't have access to this method without reflection.
10411041
*
1042-
* @link https://github.com/lucee/Lucee/blob/6.0/core/src/main/java/lucee/commons/lang/StringUtil.java#L870
1042+
* @see <a href="https://github.com/lucee/Lucee/blob/6.0/core/src/main/java/lucee/commons/lang/StringUtil.java#L870">Lucee core StringUtil.java</a>
10431043
*
10441044
* @param str
10451045
* string to check first char
@@ -1057,7 +1057,7 @@ public static boolean startsWith(String str, char prefix) {
10571057
* <p>
10581058
* Blatantly copied from the Lucee core, since we don't have access to this method without reflection.
10591059
*
1060-
* @link https://github.com/lucee/Lucee/blob/6.0/core/src/main/java/lucee/commons/lang/StringUtil.java#L870
1060+
* @see <a href="https://github.com/lucee/Lucee/blob/6.0/core/src/main/java/lucee/commons/lang/StringUtil.java#L870">Lucee core StringUtil.java</a>
10611061
*
10621062
* @param str
10631063
* string to check first char

source/java/src/org/lucee/extension/orm/hibernate/util/ConfigurationBuilder.java

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,8 @@ public class ConfigurationBuilder {
4747
private Log log;
4848

4949
/**
50-
* Build out Hibernate configuration using the application's `this.ormSettings`, datasource, and generated mappings.
51-
*
52-
* @param log
53-
* Lucee logger object, configured for the ORM log
54-
* @param mappings
55-
* Mapping XML document as a string
56-
* @param ds
57-
* Datasource to operate on
58-
* @param user
59-
* Username for the configured datasource
60-
* @param pass
61-
* Password for the configured datasource
62-
* @param data
63-
* The extension {@link org.lucee.extension.orm.hibernate.SessionFactoryData}
64-
* @param applicationName
65-
* Application name
50+
* Build out Hibernate configuration using the application's {@code this.ormSettings}, datasource, and generated mappings.
51+
* Use the builder setter methods to configure log, mappings, datasource, credentials, data, and application name before calling.
6652
*
6753
* @return Hibernate Configuration object
6854
*

source/java/src/org/lucee/extension/orm/hibernate/util/XMLUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public static Document newDocument() throws PageException {
7878
* @param document
7979
* The root element of an XML document.
8080
*
81-
* @return a fully-formed and formatted XML string. Does not append or prepend <xml> tags or DOCTYPE, etc.
81+
* @return a fully-formed and formatted XML string. Does not append or prepend {@code <xml>} tags or DOCTYPE, etc.
8282
*
8383
* @throws PageException
8484
*/

0 commit comments

Comments
 (0)