You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ja...@apache.org on 2026/05/30 07:12:33 UTC
(ofbiz-plugins) 03/04: Improved: Check and enhance the Javadoc rules/documentation for the project (OFBIZ-9148)
This is an automated email from the ASF dual-hosted git repository.
jacopoc pushed a commit to branch release24.09
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git
commit 2a67005740af3a871ccacf4f4f57644d4a878a5e
Author: Jacques Le Roux <ja...@les7arts.com>
AuthorDate: Fri Mar 14 09:07:48 2025 +0100
Improved: Check and enhance the Javadoc rules/documentation for the project (OFBIZ-9148)
Remove useless </p> that generates errors: unexpected end tag: </p>
Those are a bit different than those fixed in previous commit.
The indentation is 5 spaces not 4. I decided to not change that, just removing
the </p>
(cherry picked from commit a52f9fb2dcb085125cf3845efd11f3d287fc022a)
---
.../apache/ofbiz/birt/flexible/BirtServices.java | 3 +-
.../OFBizActiveDirectoryAuthenticationHandler.java | 3 +-
.../ldap/cas/OFBizCasAuthenticationHandler.java | 3 +-
.../AbstractOFBizAuthenticationHandler.java | 3 +-
.../openldap/OFBizLdapAuthenticationHandler.java | 3 +-
.../ofbiz/htmlreport/AbstractHtmlReport.java | 3 +-
.../apache/ofbiz/htmlreport/AbstractReport.java | 21 ++-
.../org/apache/ofbiz/htmlreport/HtmlReport.java | 168 ++++++++++++++-------
.../apache/ofbiz/htmlreport/InterfaceReport.java | 66 +++++---
.../ofbiz/htmlreport/InterfaceReportThread.java | 6 +-
.../ofbiz/htmlreport/sample/SampleHtmlReport.java | 3 +-
.../ofbiz/htmlreport/util/ReportEncoder.java | 87 +++++++----
.../ofbiz/htmlreport/util/ReportStringUtil.java | 84 +++++++----
.../ofbiz/pricat/PricatParseExcelHtmlReport.java | 6 +-
14 files changed, 306 insertions(+), 153 deletions(-)
diff --git a/birt/src/main/java/org/apache/ofbiz/birt/flexible/BirtServices.java b/birt/src/main/java/org/apache/ofbiz/birt/flexible/BirtServices.java
index 77ce2ee04..1feb37be9 100644
--- a/birt/src/main/java/org/apache/ofbiz/birt/flexible/BirtServices.java
+++ b/birt/src/main/java/org/apache/ofbiz/birt/flexible/BirtServices.java
@@ -688,7 +688,8 @@ public class BirtServices {
/**
* Update birt rptdesign file from uploaded one.
- * <p>This will update only STYLES, BODY, MASTERPAGE AND CUBES from existing rptdesign with uploaded ones.</p>
+ * <p>This will update only STYLES, BODY, MASTERPAGE AND CUBES from existing rptdesign with uploaded ones.
+ *
*/
public static Map<String, Object> uploadRptDesign(DispatchContext dctx, Map<String, Object> context) {
String dataResourceId = (String) context.get("dataResourceIdRpt");
diff --git a/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java b/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java
index f98ddebf7..a646bdede 100644
--- a/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java
+++ b/ldap/src/main/java/org/apache/ofbiz/ldap/activedirectory/OFBizActiveDirectoryAuthenticationHandler.java
@@ -45,7 +45,8 @@ import org.w3c.dom.Element;
public final class OFBizActiveDirectoryAuthenticationHandler extends AbstractOFBizAuthenticationHandler {
/**
- * Public constructor, initializes some required member variables.<p>
+ * Public constructor, initializes some required member variables.
+ *
*/
public OFBizActiveDirectoryAuthenticationHandler() {
diff --git a/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java b/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java
index c93d3307b..cbdb63693 100644
--- a/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java
+++ b/ldap/src/main/java/org/apache/ofbiz/ldap/cas/OFBizCasAuthenticationHandler.java
@@ -54,7 +54,8 @@ public final class OFBizCasAuthenticationHandler extends AbstractOFBizAuthentica
private static final SecureRandom SECURE_RANDOM = new SecureRandom();
/**
- * Public constructor, initializes some required member variables.<p>
+ * Public constructor, initializes some required member variables.
+ *
*/
public OFBizCasAuthenticationHandler() { // FIXME: I see nothing happening here and it's never called, remove it?
}
diff --git a/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java b/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java
index 39751db2d..a208f7d1f 100644
--- a/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java
+++ b/ldap/src/main/java/org/apache/ofbiz/ldap/commons/AbstractOFBizAuthenticationHandler.java
@@ -59,7 +59,8 @@ import org.apache.ofbiz.service.ServiceUtil;
public abstract class AbstractOFBizAuthenticationHandler implements InterfaceOFBizAuthenticationHandler {
/**
- * Public constructor, initializes some required member variables.<p>
+ * Public constructor, initializes some required member variables.
+ *
*/
public AbstractOFBizAuthenticationHandler() {
diff --git a/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java b/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java
index daa6bd411..6e4c9c5ed 100644
--- a/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java
+++ b/ldap/src/main/java/org/apache/ofbiz/ldap/openldap/OFBizLdapAuthenticationHandler.java
@@ -44,7 +44,8 @@ import org.w3c.dom.Element;
public final class OFBizLdapAuthenticationHandler extends AbstractOFBizAuthenticationHandler {
/**
- * Public constructor, initializes some required member variables.<p>
+ * Public constructor, initializes some required member variables.
+ *
*/
public OFBizLdapAuthenticationHandler() {
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractHtmlReport.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractHtmlReport.java
index 68a4d913e..b8a08c1e0 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractHtmlReport.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractHtmlReport.java
@@ -76,7 +76,8 @@ public abstract class AbstractHtmlReport extends HtmlReport {
}
/**
- * Initializes the report thread to use for this report.<p>
+ * Initializes the report thread to use for this report.
+ *
* @return the reported thread to use for this report.
*/
public abstract InterfaceReportThread initializeThread(HttpServletRequest request, HttpServletResponse response, String name);
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractReport.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractReport.java
index ed0f02d31..e6fcec750 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractReport.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/AbstractReport.java
@@ -135,7 +135,8 @@ public abstract class AbstractReport implements InterfaceReport {
}
/**
- * Initializes some member variables for this report.<p>
+ * Initializes some member variables for this report.
+ *
* @param locale the locale for this report
*/
protected void init(Locale locale) {
@@ -145,7 +146,8 @@ public abstract class AbstractReport implements InterfaceReport {
}
/**
- * Prints a String to the report.<p>
+ * Prints a String to the report.
+ *
* @param value the String to add
*/
@Override
@@ -154,9 +156,11 @@ public abstract class AbstractReport implements InterfaceReport {
}
/**
- * Prints a String to the report, using the indicated formatting.<p>
+ * Prints a String to the report, using the indicated formatting.
+ *
* Use the contants starting with <code>FORMAT</code> from this interface
- * to indicate which formatting to use.<p>
+ * to indicate which formatting to use.
+ *
* @param value the message container to add
* @param format the formatting to use for the output
*/
@@ -164,7 +168,8 @@ public abstract class AbstractReport implements InterfaceReport {
public abstract void print(String value, int format);
/**
- * Prints a String with line break to the report.<p>
+ * Prints a String with line break to the report.
+ *
* @param value the message container to add
*/
@Override
@@ -174,9 +179,11 @@ public abstract class AbstractReport implements InterfaceReport {
}
/**
- * Prints a String with line break to the report, using the indicated formatting.<p>
+ * Prints a String with line break to the report, using the indicated formatting.
+ *
* Use the contants starting with <code>FORMAT</code> from this interface
- * to indicate which formatting to use.<p>
+ * to indicate which formatting to use.
+ *
* @param value the String to add
* @param format the formatting to use for the output
*/
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/HtmlReport.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/HtmlReport.java
index 70a6b8468..db19a35a6 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/HtmlReport.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/HtmlReport.java
@@ -168,7 +168,8 @@ public class HtmlReport extends AbstractReport {
private long sequenceNum = -1;
/**
- * Constructs a new report using the provided locale for the output language.<p>
+ * Constructs a new report using the provided locale for the output language.
+ *
* @param request HttpServletRequest
* @param response HttpServletResponse
*/
@@ -178,7 +179,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Constructs a new report using the provided locale for the output language.<p>
+ * Constructs a new report using the provided locale for the output language.
+ *
* @param request HttpServletRequest
* @param response HttpServletResponse
* @param writeHtml if <code>true</code>, this report should generate HTML instead of JavaScript output
@@ -286,7 +288,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns if the report writes html or javascript code.<p>
+ * Returns if the report writes html or javascript code.
+ *
* @return <code>true</code> if the report writes html, and <code>false</code> if the report writes javascript code
*/
public boolean isWriteHtml() {
@@ -406,12 +409,15 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Output helper method to format a reported <code>Throwable</code> element.<p>
+ * Output helper method to format a reported <code>Throwable</code> element.
+ *
* This method ensures that exception stack traces are properly escaped
- * when they are added to the report.<p>
+ * when they are added to the report.
+ *
* There is a member variable {@link #showExceptionStackTrace} in this
* class that controls if the stack track is shown or not.
- * In a later version this might be configurable on a per-user basis.<p>
+ * In a later version this might be configurable on a per-user basis.
+ *
* @param throwable the exception to format
* @return the formatted StringBuffer
*/
@@ -478,8 +484,10 @@ public class HtmlReport extends AbstractReport {
/**
* Builds the start html of the page, including setting of DOCTYPE and
- * inserting a header with the content-type.<p>
- * This overloads the default method of the parent class.<p>
+ * inserting a header with the content-type.
+ *
+ * This overloads the default method of the parent class.
+ *
* @return the start html of the page
*/
public String htmlStart() {
@@ -489,8 +497,10 @@ public class HtmlReport extends AbstractReport {
/**
* Builds the start html of the page, including setting of DOCTYPE and
- * inserting a header with the content-type.<p>
- * This overloads the default method of the parent class.<p>
+ * inserting a header with the content-type.
+ *
+ * This overloads the default method of the parent class.
+ *
* @param loadStyles if true, the defaul style sheet will be loaded
* @return the start html of the page
*/
@@ -501,8 +511,10 @@ public class HtmlReport extends AbstractReport {
/**
* Builds the start html of the page, including setting of DOCTYPE and
- * inserting a header with the content-type.<p>
- * This overloads the default method of the parent class.<p>
+ * inserting a header with the content-type.
+ *
+ * This overloads the default method of the parent class.
+ *
* @param segment the HTML segment (START / END)
* @param loadStyles if true, the defaul style sheet will be loaded
* @return the start html of the page
@@ -528,7 +540,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the standard javascript for submitting the dialog.<p>
+ * Builds the standard javascript for submitting the dialog.
+ *
* @return the standard javascript for submitting the dialog
*/
public String dialogScriptSubmit() {
@@ -545,7 +558,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns true if the report Thread is still alive (i.e. running), false otherwise.<p>
+ * Returns true if the report Thread is still alive (i.e. running), false otherwise.
+ *
* @return true if the report Thread is still alive
*/
public boolean isAlive(HttpServletRequest request) {
@@ -571,7 +585,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the thread parameter value.<p>
+ * Returns the thread parameter value.
+ *
* @return the thread parameter value
*/
public String getParamThread(HttpServletRequest request) {
@@ -580,7 +595,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the threadhasnext parameter value.<p>
+ * Returns the threadhasnext parameter value.
+ *
* @return the threadhasnext parameter value
*/
public String getParamThreadHasNext(HttpServletRequest request) {
@@ -589,7 +605,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the start html of the body.<p>
+ * Builds the start html of the body.
+ *
* @param className optional class attribute to add to the body tag
* @param parameters optional parameters to add to the body tag
* @return the start html of the body
@@ -599,7 +616,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the html of the body.<p>
+ * Builds the html of the body.
+ *
* @param segment the HTML segment (START / END)
* @param className optional class attribute to add to the body tag
* @param parameters optional parameters to add to the body tag
@@ -626,7 +644,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the end html of the body.<p>
+ * Builds the end html of the body.
+ *
* @return the end html of the body
*/
public String bodyEnd() {
@@ -634,7 +653,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the end html of the page.<p>
+ * Builds the end html of the page.
+ *
* @return the end html of the page
*/
public String htmlEnd() {
@@ -643,7 +663,8 @@ public class HtmlReport extends AbstractReport {
/**
* Returns the default html for a workplace page, including setting of DOCTYPE and
- * inserting a header with the content-type.<p>
+ * inserting a header with the content-type.
+ *
* @param segment the HTML segment (START / END)
* @param title the title of the page, if null no title tag is inserted
* @return the default html for a workplace page
@@ -654,7 +675,8 @@ public class HtmlReport extends AbstractReport {
/**
* Returns the default html for a workplace page, including setting of DOCTYPE and
- * inserting a header with the content-type, allowing the selection of an individual style sheet.<p>
+ * inserting a header with the content-type, allowing the selection of an individual style sheet.
+ *
* @param segment the HTML segment (START / END)
* @param title the title of the page, if null no title tag is inserted
* @param stylesheet the used style sheet, if null the default stylesheet 'workplace.css' is inserted
@@ -712,7 +734,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the start html for the content area of the dialog window.<p>
+ * Returns the start html for the content area of the dialog window.
+ *
* @param title the title for the dialog
* @return the start html for the content area of the dialog window
*/
@@ -721,7 +744,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the content area of the dialog window.<p>
+ * Builds the content area of the dialog window.
+ *
* @param segment the HTML segment (START / END)
* @param title the title String for the dialog window
* @return a content area start / end segment
@@ -740,7 +764,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the title of the dialog window.<p>
+ * Builds the title of the dialog window.
+ *
* @param title the title String for the dialog window
* @return the HTML title String for the dialog window
*/
@@ -750,10 +775,12 @@ public class HtmlReport extends AbstractReport {
/**
* Returns the value of the title parameter,
- * or null if this parameter was not provided.<p>
+ * or null if this parameter was not provided.
+ *
* This parameter is used to build the title
* of the dialog. It is a parameter so that the title
- * can be passed to included elements.<p>
+ * can be passed to included elements.
+ *
* @return the value of the title parameter
*/
public String getParamTitle(HttpServletRequest request) {
@@ -765,7 +792,8 @@ public class HtmlReport extends AbstractReport {
/**
* Returns all initialized parameters of the current workplace class
- * as hidden field tags that can be inserted in a form.<p>
+ * as hidden field tags that can be inserted in a form.
+ *
* @return all initialized parameters of the current workplace class
* as hidden field tags that can be inserted in a html form
*/
@@ -775,7 +803,8 @@ public class HtmlReport extends AbstractReport {
/**
* Returns all initialized parameters of the current workplace class
- * that are not in the given exclusion list as hidden field tags that can be inserted in a form.<p>
+ * that are not in the given exclusion list as hidden field tags that can be inserted in a form.
+ *
* @param excludes the parameters to exclude
* @return all initialized parameters of the current workplace class
* that are not in the given exclusion list as hidden field tags that can be inserted in a form
@@ -801,7 +830,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the values of all parameter methods of this workplace class instance.<p>
+ * Returns the values of all parameter methods of this workplace class instance.
+ *
* @return the values of all parameter methods of this workplace class instance
*/
protected Map<String, Object> paramValues(HttpServletRequest request) {
@@ -825,7 +855,8 @@ public class HtmlReport extends AbstractReport {
/**
* Returns a list of all methods of the current class instance that
- * start with "getParam" and have no parameters.<p>
+ * start with "getParam" and have no parameters.
+ *
* @return a list of all methods of the current class instance that
* start with "getParam" and have no parameters
*/
@@ -844,7 +875,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns an optional introduction text to be displayed above the report output.<p>
+ * Returns an optional introduction text to be displayed above the report output.
+ *
* @return an optional introduction text
*/
public String reportIntroductionText() {
@@ -852,7 +884,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns an optional conclusion text to be displayed below the report output.<p>
+ * Returns an optional conclusion text to be displayed below the report output.
+ *
* @return an optional conclusion text
*/
public String reportConclusionText() {
@@ -860,7 +893,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the end html for the content area of the dialog window.<p>
+ * Returns the end html for the content area of the dialog window.
+ *
* @return the end html for the content area of the dialog window
*/
public String dialogContentEnd() {
@@ -868,8 +902,10 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds a button row with an "Ok" and a "Cancel" button.<p>
- * This row is displayed when the first report is running.<p>
+ * Builds a button row with an "Ok" and a "Cancel" button.
+ *
+ * This row is displayed when the first report is running.
+ *
* @param okAttrs optional attributes for the ok button
* @param cancelAttrs optional attributes for the cancel button
* @return the button row
@@ -881,8 +917,10 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds a button row with an "OK" and a "Cancel" button.<p>
- * This row is used when a single report is running or after the first report has finished.<p>
+ * Builds a button row with an "OK" and a "Cancel" button.
+ *
+ * This row is used when a single report is running or after the first report has finished.
+ *
* @param okAttrs optional attributes for the ok button
* @param cancelAttrs optional attributes for the cancel button
* @return the button row
@@ -897,8 +935,10 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds a button row with an "OK", a "Cancel" and a "Download" button.<p>
- * This row is used when a single report is running or after the first report has finished.<p>
+ * Builds a button row with an "OK", a "Cancel" and a "Download" button.
+ *
+ * This row is used when a single report is running or after the first report has finished.
+ *
* @param okAttrs optional attributes for the ok button
* @param cancelAttrs optional attributes for the cancel button
* @param downloadAttrs optional attributes for the download button
@@ -922,7 +962,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the html for the button row under the dialog content area, including buttons.<p>
+ * Builds the html for the button row under the dialog content area, including buttons.
+ *
* @param buttons array of constants of which buttons to include in the row
* @param attributes array of Strings for additional button attributes
* @return the html for the button row under the dialog content area, including buttons
@@ -938,7 +979,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Builds the button row under the dialog content area without the buttons.<p>
+ * Builds the button row under the dialog content area without the buttons.
+ *
* @param segment the HTML segment (START / END)
* @return the button row start / end segment
*/
@@ -951,7 +993,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Renders the HTML for a single input button of a specified type.<p>
+ * Renders the HTML for a single input button of a specified type.
+ *
* @param result a string buffer where the rendered HTML gets appended to
* @param button a integer key to identify the button
* @param attribute an optional string with possible tag attributes, or null
@@ -1073,7 +1116,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Appends a space char. between tag attributes.<p>
+ * Appends a space char. between tag attributes.
+ *
* @param attribute a tag attribute
* @return the tag attribute with a leading space char
*/
@@ -1090,7 +1134,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns true if the dialog operation has to be performed on multiple resources.<p>
+ * Returns true if the dialog operation has to be performed on multiple resources.
+ *
* @return true if the dialog operation has to be performed on multiple resources, otherwise false
*/
public boolean isMultiOperation(HttpServletRequest request) {
@@ -1125,8 +1170,10 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the value of the RESOURCE list parameter, or null if the parameter is not provided.<p>
- * This parameter selects the resources to perform operations on.<p>
+ * Returns the value of the RESOURCE list parameter, or null if the parameter is not provided.
+ *
+ * This parameter selects the resources to perform operations on.
+ *
* @return the value of the RESOURCE list parameter or null, if the parameter is not provided
*/
public String getParamResourcelist(HttpServletRequest request) {
@@ -1139,9 +1186,11 @@ public class HtmlReport extends AbstractReport {
/**
* Returns the value of the file parameter,
- * or null if this parameter was not provided.<p>
+ * or null if this parameter was not provided.
+ *
* The file parameter selects the file on which the dialog action
- * is to be performed.<p>
+ * is to be performed.
+ *
* @return the value of the file parameter
*/
public String getParamResource(HttpServletRequest request) {
@@ -1154,7 +1203,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns if the workplace must be refreshed.<p>
+ * Returns if the workplace must be refreshed.
+ *
* @return <code>"true"</code> if the workplace must be refreshed.
*/
public String getParamRefreshWorkplace() {
@@ -1162,7 +1212,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the key name which contains the localized message for the continue checkbox.<p>
+ * Returns the key name which contains the localized message for the continue checkbox.
+ *
* @return the key name which contains the localized message for the continue checkbox
*/
public String getParamReportContinueKey() {
@@ -1175,8 +1226,10 @@ public class HtmlReport extends AbstractReport {
/**
* Returns the value of the resourcelist parameter in form of a String separated
* with {@link #DELIMITER_RESOURCES}, or the value of the RESOURCE parameter if the
- * first parameter is not provided (no multiple choice has been done.<p>
- * This may be used for jsps as value for the parameter for resources {@link #PARAM_RESOURCELIST}.<p>
+ * first parameter is not provided (no multiple choice has been done.
+ *
+ * This may be used for jsps as value for the parameter for resources {@link #PARAM_RESOURCELIST}.
+ *
* @return the value of the resourcelist parameter or null, if the parameter is not provided
*/
public String getResourceListAsParam(HttpServletRequest request) {
@@ -1188,7 +1241,8 @@ public class HtmlReport extends AbstractReport {
}
/**
- * Returns the end html for the outer dialog window border.<p>
+ * Returns the end html for the outer dialog window border.
+ *
* @return the end html for the outer dialog window border
*/
public String dialogEnd() {
@@ -1196,8 +1250,10 @@ public class HtmlReport extends AbstractReport {
}
/**
* Returns the http URI of the current dialog, to be used
- * as value for the "action" attribute of a html form.<p>
- * This URI is the real one.<p>
+ * as value for the "action" attribute of a html form.
+ *
+ * This URI is the real one.
+ *
* @return the http URI of the current dialog
*/
public String getDialogRealUri(HttpServletRequest request) {
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java
index 70476386e..ab93047c8 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReport.java
@@ -53,96 +53,113 @@ public interface InterfaceReport {
String REPORT_TYPE_SIMPLE = "simple";
/**
- * Adds an error object to the list of errors that occured during the report.<p>
+ * Adds an error object to the list of errors that occured during the report.
+ *
* @param obj the error object
*/
void addError(Object obj);
/**
- * Adds a warning object to the list of warnings that occured during the report.<p>
+ * Adds a warning object to the list of warnings that occured during the report.
+ *
* @param obj the error object
*/
void addWarning(Object obj);
/**
- * Formats the runtime formatted as "hh:mm:ss".<p>
+ * Formats the runtime formatted as "hh:mm:ss".
+ *
* @return the runtime formatted as "hh:mm:ss"
*/
String formatRuntime();
/**
- * Returns a list of all errors that occured during the report.<p>
+ * Returns a list of all errors that occured during the report.
+ *
* @return an error list that occured during the report
*/
List<Object> getErrors();
/**
- * Returns the locale this report was initialized with.<p>
+ * Returns the locale this report was initialized with.
+ *
* @return the locale this report was initialized with
*/
Locale getLocale();
/**
* Updates this report, this processes all new output added since
- * the last call to this method.<p>
+ * the last call to this method.
+ *
* This is only required in case the output is written to a HTML page,
- * if the shell output is used, this will just return an empty String.<p>
+ * if the shell output is used, this will just return an empty String.
+ *
* @return new elements that have been added to the report and not yet processed.
*/
String getReportUpdate();
/**
- * Returns the time this report has been running.<p>
+ * Returns the time this report has been running.
+ *
* @return the time this report has been running
*/
long getRuntime();
/**
- * Returns a list of all warnings that occured during the report.<p>
+ * Returns a list of all warnings that occured during the report.
+ *
* @return a warning list that occured during the report
*/
List<Object> getWarnings();
/**
- * Returns if the report generated an error output.<p>
+ * Returns if the report generated an error output.
+ *
* @return true if the report generated an error, otherwise false
*/
boolean hasError();
/**
- * Returns if the report generated a warning output.<p>
+ * Returns if the report generated a warning output.
+ *
* @return true if the report generated a warning, otherwise false
*/
boolean hasWarning();
/**
- * Prints a localized message to the report.<p>
+ * Prints a localized message to the report.
+ *
* @param uiLabel the String to add
*/
void print(String uiLabel);
/**
- * Prints a localized message to the report, using the indicated formatting.<p>
+ * Prints a localized message to the report, using the indicated formatting.
+ *
* Use the contants starting with <code>FORMAT</code> from this interface
- * to indicate which formatting to use.<p>
+ * to indicate which formatting to use.
+ *
* @param uiLabel the String to add
* @param format the formatting to use for the output
*/
void print(String uiLabel, int format);
/**
- * Adds a line break to the report.<p>
+ * Adds a line break to the report.
+ *
*/
void println();
/**
- * Prints a localized message to the report.<p>
+ * Prints a localized message to the report.
+ *
* @param uiLabel the message to add
*/
void println(String uiLabel);
/**
- * Prints a localized message to the report, using the indicated formatting.<p>
+ * Prints a localized message to the report, using the indicated formatting.
+ *
* Use the contents starting with <code>FORMAT</code> from this interface
* to indicate which formatting to use.
* @param uiLabel the message container to add
@@ -152,22 +169,26 @@ public interface InterfaceReport {
/**
* Adds an Exception to the report, ensuring that the Exception content is
- * processed to generate a valid output esp. for HTML pages.<p>
+ * processed to generate a valid output esp. for HTML pages.
+ *
* The exception will be stored and the output will later be processed
- * in a special way.<p>
+ * in a special way.
+ *
* @param t the exception to add
*/
void println(Throwable t);
/**
- * Prints a localized message followed by a parameter and dots to the report.<p>
+ * Prints a localized message followed by a parameter and dots to the report.
+ *
* @param uiLabel the Message to add
* @param param the Parameter to add
*/
void printMessageWithParam(String uiLabel, Object param);
/**
- * Convenience method to print a localized message, followed by a parameter and dots to the report.<p>
+ * Convenience method to print a localized message, followed by a parameter and dots to the report.
+ *
* The output follows the pattern: ( 3 / 8 ) Deleting filename.txt ...
* @param m the number of the report output
* @param n the total number of report outputs
@@ -177,7 +198,8 @@ public interface InterfaceReport {
void printMessageWithParam(int m, int n, String uiLabel, Object param);
/**
- * Resets the runtime to 0 milliseconds.<p>
+ * Resets the runtime to 0 milliseconds.
+ *
*/
void resetRuntime();
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReportThread.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReportThread.java
index d1f6d8a24..0ba12ff76 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReportThread.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/InterfaceReportThread.java
@@ -26,12 +26,14 @@ import org.safehaus.uuid.UUID;
public interface InterfaceReportThread {
/**
- * Starts the report thread.<p>
+ * Starts the report thread.
+ *
*/
void start();
/**
- * Returns the UUID of this report thread.<p>
+ * Returns the UUID of this report thread.
+ *
* @return the UUID of this report thread
*/
UUID getUUID();
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/sample/SampleHtmlReport.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/sample/SampleHtmlReport.java
index d73072b76..99d90c52f 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/sample/SampleHtmlReport.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/sample/SampleHtmlReport.java
@@ -30,7 +30,8 @@ import org.apache.ofbiz.htmlreport.InterfaceReportThread;
public class SampleHtmlReport extends AbstractHtmlReport {
/**
- * Public constructor with report variables.<p>
+ * Public constructor with report variables.
+ *
* @param request the HttpServletRequest request
* @param response the HttpServletResponse response
*/
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java
index 3babc89ef..a55b69ccb 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java
@@ -49,7 +49,8 @@ public final class ReportEncoder {
public static final String ENCODING_US_ASCII = "US-ASCII";
/**
- * Constant for the standard <code>UTF-8</code> encoding.<p>
+ * Constant for the standard <code>UTF-8</code> encoding.
+ *
* Default encoding for JavaScript decodeUriComponent methods is <code>UTF-8</code> by w3c standard.
*/
public static final String ENCODING_UTF_8 = "UTF-8";
@@ -70,7 +71,8 @@ public final class ReportEncoder {
private static final String PLUS_ENTITY = ENTITY_PREFIX + "043;";
/**
- * Constructor.<p>
+ * Constructor.
+ *
*/
private ReportEncoder() {
// empty
@@ -79,7 +81,8 @@ public final class ReportEncoder {
/**
* Adjusts the given String by making sure all characters that can be displayed
* in the given charset are contained as chars, whereas all other non-displayable
- * characters are converted to HTML entities.<p>
+ * characters are converted to HTML entities.
+ *
* Just calls {@link #decodeHtmlEntities(String, String)} first and feeds the result
* to {@link #encodeHtmlEntities(String, String)}.
* @param input the input to adjust the HTML encoding for
@@ -92,7 +95,8 @@ public final class ReportEncoder {
}
/**
- * Changes the encoding of a byte array that represents a String.<p>
+ * Changes the encoding of a byte array that represents a String.
+ *
* @param input the byte array to convert
* @param oldEncoding the current encoding of the byte array
* @param newEncoding the new encoding of the byte array
@@ -117,9 +121,11 @@ public final class ReportEncoder {
/**
* Creates a String out of a byte array with the specified encoding, falling back
- * to the system default in case the encoding name is not valid.<p>
+ * to the system default in case the encoding name is not valid.
+ *
* Use this method as a replacement for <code>new String(byte[], encoding)</code>
- * to avoid possible encoding problems.<p>
+ * to avoid possible encoding problems.
+ *
* @param bytes the bytes to decode
* @param encoding the encoding scheme to use for decoding the bytes
* @return the bytes decoded to a String
@@ -150,7 +156,8 @@ public final class ReportEncoder {
/**
* Decodes a String using UTF-8 encoding, which is the standard for http data transmission
- * with GET ant POST requests.<p>
+ * with GET ant POST requests.
+ *
* @param source the String to decode
* @return String the decoded source String
*/
@@ -160,10 +167,12 @@ public final class ReportEncoder {
}
/**
- * This method is a substitute for <code>URLDecoder.decode()</code>.<p>
+ * This method is a substitute for <code>URLDecoder.decode()</code>.
+ *
* In case you don't know what encoding to use, set the value of
* the <code>encoding</code> parameter to <code>null</code>.
- * This method will then default to UTF-8 encoding, which is probably the right one.<p>
+ * This method will then default to UTF-8 encoding, which is probably the right one.
+ *
* @param source The string to decode
* @param encoding The encoding to use (if null, the system default is used)
* @return The decoded source String
@@ -192,7 +201,8 @@ public final class ReportEncoder {
/**
* Decodes HTML entity references like <code>&#8364;</code> that are contained in the
* String to a regular character, but only if that character is contained in the given
- * encodings charset.<p>
+ * encodings charset.
+ *
* @param input the input to decode the HTML entities in
* @param encoding the charset to decode the input for
* @return the input with the decoded HTML entities
@@ -225,7 +235,8 @@ public final class ReportEncoder {
}
/**
- * Decodes a string used as parameter in an uri in a way independent of other encodings/decodings applied before.<p>
+ * Decodes a string used as parameter in an uri in a way independent of other encodings/decodings applied before.
+ *
* @param input the encoded parameter string
* @return the decoded parameter string
* @see #encodeParameter(String)
@@ -238,7 +249,8 @@ public final class ReportEncoder {
/**
* Encodes a String using UTF-8 encoding, which is the standard for http data transmission
- * with GET ant POST requests.<p>
+ * with GET ant POST requests.
+ *
* @param source the String to encode
* @return String the encoded source String
*/
@@ -248,10 +260,12 @@ public final class ReportEncoder {
}
/**
- * This method is a substitute for <code>URLEncoder.encode()</code>.<p>
+ * This method is a substitute for <code>URLEncoder.encode()</code>.
+ *
* In case you don't know what encoding to use, set the value of
* the <code>encoding</code> parameter to <code>null</code>.
- * This method will then default to UTF-8 encoding, which is probably the right one.<p>
+ * This method will then default to UTF-8 encoding, which is probably the right one.
+ *
* @param source the String to encode
* @param encoding the encoding to use (if null, the system default is used)
* @return the encoded source String
@@ -280,10 +294,12 @@ public final class ReportEncoder {
/**
* Encodes all characters that are contained in the String which can not displayed
* in the given encodings charset with HTML entity references
- * like <code>&#8364;</code>.<p>
+ * like <code>&#8364;</code>.
+ *
* This is required since a Java String is
* internally always stored as Unicode, meaning it can contain almost every character, but
- * the HTML charset used might not support all such characters.<p>
+ * the HTML charset used might not support all such characters.
+ *
* @param input the input to encode for HTML
* @param encoding the charset to encode the result with
* @return the input with the encoded HTML entities
@@ -317,8 +333,10 @@ public final class ReportEncoder {
/**
* Encodes all characters that are contained in the String which can not displayed
- * in the given encodings charset with Java escaping like <code>\u20ac</code>.<p>
- * This can be used to escape values used in Java property files.<p>
+ * in the given encodings charset with Java escaping like <code>\u20ac</code>.
+ *
+ * This can be used to escape values used in Java property files.
+ *
* @param input the input to encode for Java
* @param encoding the charset to encode the result with
* @return the input with the encoded Java entities
@@ -354,11 +372,13 @@ public final class ReportEncoder {
}
/**
- * Encodes a string used as parameter in an uri in a way independent of other encodings/decodings applied later.<p>
+ * Encodes a string used as parameter in an uri in a way independent of other encodings/decodings applied later.
+ *
* Used to ensure that GET parameters are not wrecked by wrong or incompatible configuration settings.
* In order to ensure this, the String is first encoded with html entities for any character that cannot encoded
* in US-ASCII; additionally, the plus sign is also encoded to avoid problems with the white-space replacer.
- * Finally, the entity prefix is replaced with characters not used as delimiters in urls.<p>
+ * Finally, the entity prefix is replaced with characters not used as delimiters in urls.
+ *
* @param input the parameter string
* @return the encoded parameter string
*/
@@ -383,7 +403,8 @@ public final class ReportEncoder {
/**
* Escapes special characters in a HTML-String with their number-based
- * entity representation, for example & becomes &#38;.<p>
+ * entity representation, for example & becomes &#38;.
+ *
* A character <code>num</code> is replaced if<br>
* <code>((ch != 32) && ((ch > 122) || (ch < 48) || (ch == 60) || (ch == 62)))</code>
* @param source the String to escape
@@ -424,7 +445,8 @@ public final class ReportEncoder {
/**
* Escapes non ASCII characters in a HTML-String with their number-based
- * entity representation, for example & becomes &#38;.<p>
+ * entity representation, for example & becomes &#38;.
+ *
* A character <code>num</code> is replaced if<br>
* <code>(ch > 255)</code>
* @param source the String to escape
@@ -452,7 +474,8 @@ public final class ReportEncoder {
/**
* Encodes a String in a way that is compatible with the JavaScript escape function.
- * Multiple blanks are encoded _multiply _with <code>%20</code>.<p>
+ * Multiple blanks are encoded _multiply _with <code>%20</code>.
+ *
* @param source The text to be encoded
* @param encoding the encoding type
* @return The JavaScript escaped string
@@ -482,7 +505,8 @@ public final class ReportEncoder {
/**
* Escapes a String so it may be printed as text content or attribute
- * value in a HTML page or an XML file.<p>
+ * value in a HTML page or an XML file.
+ *
* This method replaces the following characters in a String:
* <ul>
* <li><b><</b> with &lt;
@@ -501,7 +525,8 @@ public final class ReportEncoder {
/**
* Escapes a String so it may be printed as text content or attribute
- * value in a HTML page or an XML file.<p>
+ * value in a HTML page or an XML file.
+ *
* This method replaces the following characters in a String:
* <ul>
* <li><b><</b> with &lt;
@@ -557,13 +582,16 @@ public final class ReportEncoder {
/**
* Checks if a given encoding name is actually supported, and if so
* resolves it to it's canonical name, if not it returns the given fallback
- * value.<p>
+ * value.
+ *
* Charsets have a set of aliases. For example, valid aliases for "UTF-8"
* are "UTF8", "utf-8" or "utf8". This method resolves any given valid charset name
* to it's "canonical" form, so that simple String comparison can be used
- * when checking charset names internally later.<p>
+ * when checking charset names internally later.
+ *
* Please see <a href="http://www.iana.org/assignments/character-sets">http://www.iana.org/assignments/character-sets</a>
- * for a list of valid charset alias names.<p>
+ * for a list of valid charset alias names.
+ *
* @param encoding the encoding to check and resolve
* @param fallback the fallback encoding scheme
* @return the resolved encoding name, or the fallback value
@@ -588,7 +616,8 @@ public final class ReportEncoder {
/**
* Decodes a String in a way that is compatible with the JavaScript
- * unescape function.<p>
+ * unescape function.
+ *
* @param source The String to be decoded
* @param encoding the encoding type
* @return The JavaScript unescaped String
diff --git a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java
index a0db23773..7bc897ef7 100644
--- a/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java
+++ b/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportStringUtil.java
@@ -55,7 +55,8 @@ public final class ReportStringUtil {
/**
* Default constructor (empty), private because this class has only
- * static methods.<p>
+ * static methods.
+ *
*/
private ReportStringUtil() {
// empty
@@ -79,7 +80,8 @@ public final class ReportStringUtil {
}
/**
- * Returns a string representation for the given collection using the given separator.<p>
+ * Returns a string representation for the given collection using the given separator.
+ *
* @param collection the collection to print
* @param separator the item separator
* @return the string representation for the given collection
@@ -99,9 +101,11 @@ public final class ReportStringUtil {
/**
* Replaces occurrences of special control characters in the given input with
- * a HTML representation.<p>
+ * a HTML representation.
+ *
* This method currently replaces line breaks to <code><br/></code> and special HTML chars
- * like <code>< > & "</code> with their HTML entity representation.<p>
+ * like <code>< > & "</code> with their HTML entity representation.
+ *
* @param source the String to escape
* @return the escaped String
*/
@@ -117,8 +121,10 @@ public final class ReportStringUtil {
}
/**
- * Escapes a String so it may be used in JavaScript String definitions.<p>
- * This method replaces line breaks, quotation marks and \ characters.<p>
+ * Escapes a String so it may be used in JavaScript String definitions.
+ *
+ * This method replaces line breaks, quotation marks and \ characters.
+ *
* @param source the String to escape
* @return the escaped String
*/
@@ -133,7 +139,8 @@ public final class ReportStringUtil {
}
/**
- * Escapes a String so it may be used as a Perl5 regular expression.<p>
+ * Escapes a String so it may be used as a Perl5 regular expression.
+ *
* This method replaces the following characters in a String:<br>
* <code>{}[]()\$^.*+/</code>
* @param source the string to escape
@@ -201,8 +208,10 @@ public final class ReportStringUtil {
}
/**
- * Formats a runtime in the format hh:mm:ss, to be used e.g. in reports.<p>
- * If the runtime is greater then 24 hours, the format dd:hh:mm:ss is used.<p>
+ * Formats a runtime in the format hh:mm:ss, to be used e.g. in reports.
+ *
+ * If the runtime is greater then 24 hours, the format dd:hh:mm:ss is used.
+ *
* @param runtime the time to format
* @return the formatted runtime
*/
@@ -244,7 +253,8 @@ public final class ReportStringUtil {
/**
* Returns <code>true</code> if the provided String is either <code>null</code>
- * or the empty String <code>""</code>.<p>
+ * or the empty String <code>""</code>.
+ *
* @param value the value to check
* @return true, if the provided value is null or the empty String, false otherwise
*/
@@ -255,7 +265,8 @@ public final class ReportStringUtil {
/**
* Returns <code>true</code> if the provided String is either <code>null</code>
- * or contains only white spaces.<p>
+ * or contains only white spaces.
+ *
* @param value the value to check
* @return true, if the provided value is null or contains only white spaces, false otherwise
*/
@@ -266,7 +277,8 @@ public final class ReportStringUtil {
/**
* Returns <code>true</code> if the provided Objects are either both <code>null</code>
- * or equal according to {@link Object#equals(Object)}.<p>
+ * or equal according to {@link Object#equals(Object)}.
+ *
* @param value1 the first object to compare
* @param value2 the second object to compare
* @return <code>true</code> if the provided Objects are either both <code>null</code>
@@ -282,7 +294,8 @@ public final class ReportStringUtil {
/**
* Returns <code>true</code> if the provided String is neither <code>null</code>
- * nor the empty String <code>""</code>.<p>
+ * nor the empty String <code>""</code>.
+ *
* @param value the value to check
* @return true, if the provided value is not null and not the empty String, false otherwise
*/
@@ -293,7 +306,8 @@ public final class ReportStringUtil {
/**
* Returns <code>true</code> if the provided String is neither <code>null</code>
- * nor contains only white spaces.<p>
+ * nor contains only white spaces.
+ *
* @param value the value to check
* @return <code>true</code>, if the provided value is <code>null</code>
* or contains only white spaces, <code>false</code> otherwise
@@ -304,8 +318,10 @@ public final class ReportStringUtil {
}
/**
- * Returns the last index of any of the given chars in the given source.<p>
- * If no char is found, -1 is returned.<p>
+ * Returns the last index of any of the given chars in the given source.
+ *
+ * If no char is found, -1 is returned.
+ *
* @param source the source to check
* @param chars the chars to find
* @return the last index of any of the given chars in the given source, or -1
@@ -325,8 +341,10 @@ public final class ReportStringUtil {
}
/**
- * Returns the last index a whitespace char the given source.<p>
- * If no whitespace char is found, -1 is returned.<p>
+ * Returns the last index a whitespace char the given source.
+ *
+ * If no whitespace char is found, -1 is returned.
+ *
* @param source the source to check
* @return the last index a whitespace char the given source, or -1
*/
@@ -346,10 +364,12 @@ public final class ReportStringUtil {
}
/**
- * Substitutes <code>searchString</code> in the given source String with <code>replaceString</code>.<p>
+ * Substitutes <code>searchString</code> in the given source String with <code>replaceString</code>.
+ *
* This is a high-performance implementation which should be used as a replacement for
* <code>{@link String#replaceAll(java.lang.String, java.lang.String)}</code> in case no
- * regular expression evaluation is required.<p>
+ * regular expression evaluation is required.
+ *
* @param source the content which is scanned
* @param searchString the String which is searched in content
* @param replaceString the String which replaces <code>searchString</code>
@@ -409,7 +429,8 @@ public final class ReportStringUtil {
* Returns the java String literal for the given String. <p>
* This is the form of the String that had to be written into source code
* using the unicode escape sequence for special characters. <p>
- * Example: "�" would be transformed to "\\u00C4".<p>
+ * Example: "�" would be transformed to "\\u00C4".
+ *
* @param s a string that may contain non-ascii characters
* @return the java unicode escaped string Literal of the given input string
*/
@@ -432,9 +453,11 @@ public final class ReportStringUtil {
}
/**
- * Returns a substring of the source, which is at most length characters long.<p>
+ * Returns a substring of the source, which is at most length characters long.
+ *
* This is the same as calling {@link #trimToSize(String, int, String)} with the
- * parameters <code>(source, length, " ...")</code>.<p>
+ * parameters <code>(source, length, " ...")</code>.
+ *
* @param source the string to trim
* @param length the maximum length of the string to be returned
* @return a substring of the source, which is at most length characters long
@@ -445,12 +468,15 @@ public final class ReportStringUtil {
}
/**
- * Returns a substring of the source, which is at most length characters long.<p>
- * If a char is cut, the given <code>suffix</code> is appended to the result.<p>
+ * Returns a substring of the source, which is at most length characters long.
+ *
+ * If a char is cut, the given <code>suffix</code> is appended to the result.
+ *
* This is almost the same as calling {@link #trimToSize(String, int, int, String)} with the
* parameters <code>(source, length, length*, suffix)</code>. If <code>length</code>
* if larger then 100, then <code>length* = length / 2</code>,
- * otherwise <code>length* = length</code>.<p>
+ * otherwise <code>length* = length</code>.
+ *
* @param source the string to trim
* @param length the maximum length of the string to be returned
* @param suffix the suffix to append in case the String was trimmed
@@ -464,8 +490,10 @@ public final class ReportStringUtil {
/**
* Returns a substring of the source, which is at most length characters long, cut
- * in the last <code>area</code> chars in the source at a sentence ending char or whitespace.<p>
- * If a char is cut, the given <code>suffix</code> is appended to the result.<p>
+ * in the last <code>area</code> chars in the source at a sentence ending char or whitespace.
+ *
+ * If a char is cut, the given <code>suffix</code> is appended to the result.
+ *
* @param source the string to trim
* @param length the maximum length of the string to be returned
* @param area the area at the end of the string in which to find a sentence ender or whitespace
diff --git a/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java b/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java
index 666348245..2e2df2395 100644
--- a/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java
+++ b/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java
@@ -34,7 +34,8 @@ public class PricatParseExcelHtmlReport extends AbstractHtmlReport {
public static final String PRICAT_REPORT_CLASS = "PRICAT_HTML_REPORT";
/**
- * Public constructor with report variables.<p>
+ * Public constructor with report variables.
+ *
* @param request the HttpServletRequest request
* @param response the HttpServletResponse response
*/
@@ -106,7 +107,8 @@ public class PricatParseExcelHtmlReport extends AbstractHtmlReport {
}
/**
- * Performs the dialog actions depending on the initialized action.<p>
+ * Performs the dialog actions depending on the initialized action.
+ *
* @throws IOException
*/
@Override