This is an automated email from the ASF dual-hosted git repository. jleroux pushed a commit to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 6ac33c6064fa5538ad899aaccf0e01aa17a60b39 Author: Jacques Le Roux <jacques.le.r...@les7arts.com> AuthorDate: Fri Mar 14 09:10:56 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> --- .../webapp/ftl/RenderSubContentTransform.java | 6 ++-- .../ofbiz/shipment/packing/PackingServices.java | 3 +- .../ofbiz/shipment/packing/PackingSession.java | 3 +- .../apache/ofbiz/base/conversion/Converter.java | 3 +- .../apache/ofbiz/base/conversion/Converters.java | 3 +- .../org/apache/ofbiz/base/metrics/Metrics.java | 3 +- .../org/apache/ofbiz/base/util/GroovyUtil.java | 3 +- .../org/apache/ofbiz/base/util/Observable.java | 3 +- .../org/apache/ofbiz/base/util/ScriptUtil.java | 6 ++-- .../org/apache/ofbiz/base/util/TimeDuration.java | 3 +- .../org/apache/ofbiz/base/util/UtilObject.java | 3 +- .../org/apache/ofbiz/base/util/UtilProperties.java | 6 ++-- .../java/org/apache/ofbiz/base/util/UtilURL.java | 6 ++-- .../base/util/string/FlexibleStringExpander.java | 21 +++++++---- .../org/apache/ofbiz/base/util/string/UelUtil.java | 3 +- .../ofbiz/common/preferences/PreferenceWorker.java | 9 +++-- .../java/org/apache/ofbiz/entity/Delegator.java | 42 ++++++++++++++-------- .../apache/ofbiz/entity/jdbc/JdbcValueHandler.java | 3 +- .../ofbiz/entity/serialize/XmlSerializer.java | 6 ++-- .../org/apache/ofbiz/entity/util/EntityUtil.java | 3 +- .../org/apache/ofbiz/minilang/SimpleMethod.java | 3 +- .../service/calendar/TemporalExpressionWorker.java | 3 +- .../org/apache/ofbiz/webapp/webdav/WebDavUtil.java | 3 +- .../org/apache/ofbiz/widget/WidgetFactory.java | 3 +- .../java/org/apache/ofbiz/widget/WidgetLoader.java | 3 +- 25 files changed, 102 insertions(+), 51 deletions(-) diff --git a/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java b/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java index 89dae7ef9a..509d8cb720 100644 --- a/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java +++ b/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java @@ -55,10 +55,12 @@ public class RenderSubContentTransform implements TemplateTransformModel { * @deprecated use FreeMarkerWorker.getArg() * <p>Does a conditional search to return a value for a parameter with the passed name. Looks first to see if it was * passed as an argument to the transform. - * Secondly, it looks to see if it is passed as a parameter in the template context object.</p> + * Secondly, it looks to see if it is passed as a parameter in the template context object. + * * <p>Note that this is different from the getArg method of EditRenderDataResourceTransform, which checks the request object * instead of the template context - * object.</p> + * object. + * */ @Deprecated public static String getArg(Map<String, Object> args, String key, Environment env) { diff --git a/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingServices.java b/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingServices.java index abe7860965..ed6792b2f9 100644 --- a/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingServices.java +++ b/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingServices.java @@ -77,7 +77,8 @@ public class PackingServices { } /** - * <p>Create or update package lines.</p> + * <p>Create or update package lines. + * * Context parameters: * <ul> * <li>selInfo - selected rows</li> diff --git a/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingSession.java b/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingSession.java index 4b33107df7..6348745cb8 100644 --- a/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingSession.java +++ b/applications/product/src/main/java/org/apache/ofbiz/shipment/packing/PackingSession.java @@ -484,7 +484,8 @@ public class PackingSession implements java.io.Serializable { } /** - * <p>Delivers all the packing lines grouped by package.</p> + * <p>Delivers all the packing lines grouped by package. + * * Output map: * <ul> * <li>packageMap - a Map of type {@code Map<Integer, List<PackingSessionLine>>} diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converter.java b/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converter.java index 9ebf127a67..95e18b82a5 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converter.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converter.java @@ -28,7 +28,8 @@ public interface Converter<S, T> { /** Returns <code>true</code> if this object can convert * <code>sourceClass</code> to <code>targetClass</code>. * <p>Implementations can accomodate class hierarchy ranges - * by converting super classes or interfaces.</p> + * by converting super classes or interfaces. + * * @param sourceClass The source <code>Class</code> * @param targetClass The target <code>Class</code> * @return <code>true</code> if this object can convert diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converters.java b/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converters.java index 26014c5330..f8c38eac2e 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converters.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/conversion/Converters.java @@ -61,7 +61,8 @@ public final class Converters { * <p>This method is intended to be used when the source or * target <code>Object</code> types are unknown at compile time. * If the source and target <code>Object</code> types are known - * at compile time, then one of the "ready made" converters should be used.</p> + * at compile time, then one of the "ready made" converters should be used. + * * @param sourceClass The object class to convert from * @param targetClass The object class to convert to * @return A matching <code>Converter</code> instance diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/metrics/Metrics.java b/framework/base/src/main/java/org/apache/ofbiz/base/metrics/Metrics.java index 5d78fdea5d..26dec9f04b 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/metrics/Metrics.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/metrics/Metrics.java @@ -54,7 +54,8 @@ public interface Metrics { /** Returns the metric threshold. The meaning of the threshold is * determined by client code. * <p>The idea is for client code to compare {@link #getServiceRate()} to - * the threshold and perform some action based on the comparison.</p> + * the threshold and perform some action based on the comparison. + * */ double getThreshold(); diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/GroovyUtil.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/GroovyUtil.java index 0a6e10ce6f..4351dfac9b 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/GroovyUtil.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/GroovyUtil.java @@ -104,7 +104,8 @@ public final class GroovyUtil { * as a variable called "context" so that variables can be passed * back to the caller. Any variables that are created in the script * are lost when the script ends unless they are copied to the - * "context" <code>Map</code>.</p> + * "context" <code>Map</code>. + * * @param context A <code>Map</code> containing initial variables * @return A <code>Binding</code> instance */ diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java index a7b0224d07..81150f2a92 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/Observable.java @@ -101,7 +101,8 @@ public final class Observable { /** * Notify all of the observers. * <p>Each observer has its <code>update</code> method called with two - * arguments: this observable object and the <code>arg</code> argument.</p> + * arguments: this observable object and the <code>arg</code> argument. + * */ public void notifyObservers(Object arg) { for (Observer observer : observers) { diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptUtil.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptUtil.java index d83bf98619..e7e02446f7 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptUtil.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/ScriptUtil.java @@ -190,7 +190,8 @@ public final class ScriptUtil { * Returns a <code>ScriptContext</code> that contains the members of <code>context</code>. * <p>If a <code>CompiledScript</code> instance is to be shared by multiple threads, then * each thread must create its own <code>ScriptContext</code> and pass it to the - * <code>CompiledScript</code> eval method.</p> + * <code>CompiledScript</code> eval method. + * * @param context * @return */ @@ -211,7 +212,8 @@ public final class ScriptUtil { * Returns a <code>ScriptContext</code> that contains the members of <code>context</code>. * <p>If a <code>CompiledScript</code> instance is to be shared by multiple threads, then * each thread must create its own <code>ScriptContext</code> and pass it to the - * <code>CompiledScript</code> eval method.</p> + * <code>CompiledScript</code> eval method. + * * @param context * @param protectedKeys * @return diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/TimeDuration.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/TimeDuration.java index e82514a937..069c1eef78 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/TimeDuration.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/TimeDuration.java @@ -349,7 +349,8 @@ public class TimeDuration implements Serializable, Comparable<TimeDuration> { * returns a zero <code>TimeDuration</code>.<p>This is a convenience method * intended to be used with entity engine fields. Some duration fields are * stored as a <code>Long</code>, while others are stored as a - * <code>Double</code>. This method will decode both types.</p> + * <code>Double</code>. This method will decode both types. + * * @param number A <code>Number</code> instance, can be <code>null</code> * @return A <code>TimeDuration</code> instance */ diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilObject.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilObject.java index ad1de2f597..802ffa379d 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilObject.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilObject.java @@ -57,7 +57,8 @@ public final class UtilObject { * that the returned value is length of the byte stream after the object has * been serialized. The returned value does not represent the amount of memory * the object uses. There is no accurate way to determine the size of an - * object in memory.</p> + * object in memory. + * * @param obj * @return the number of bytes in the serialized object * @throws IOException diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilProperties.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilProperties.java index 75b7c88f89..83c99a7cad 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilProperties.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilProperties.java @@ -293,7 +293,8 @@ public final class UtilProperties implements Serializable { /** * Returns a new <code>Properties</code> instance created from <code>fileName</code>. * <p>This method is intended for low-level framework classes that need to read - * properties files before OFBiz has been fully initialized.</p> + * properties files before OFBiz has been fully initialized. + * * @param fileName The full name of the properties file ("foo.properties") * @return A new <code>Properties</code> instance created from <code>fileName</code>, or * <code>null</code> if the file was not found @@ -688,7 +689,8 @@ public final class UtilProperties implements Serializable { * if you need <a href="http://www.w3.org/International/">I18n</a> properties, then use * <a href="#getResourceBundle(java.lang.String,%20java.util.Locale)"> * getResourceBundle(String resource, Locale locale)</a>. This method is - * intended to be used primarily by the UtilProperties class.</p> + * intended to be used primarily by the UtilProperties class. + * * @param resource The name of the resource - can be a file, class, or URL * @param locale The desired locale * @return The Properties instance, or null if no matching properties are found diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilURL.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilURL.java index ab88e48ba0..afb18ea321 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilURL.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilURL.java @@ -54,7 +54,8 @@ public final class UtilURL { * <code>null</code> if the resource is not found. * <p>This method uses various ways to locate the resource, and in all * cases it tests to see if the resource exists - so it - * is very inefficient.</p> + * is very inefficient. + * * @param resourceName * @return */ @@ -74,7 +75,8 @@ public final class UtilURL { * <code>null</code> if the resource is not found. * <p>This method uses various ways to locate the resource, and in all * cases it tests to see if the resource exists - so it - * is very inefficient.</p> + * is very inefficient. + * * @param resourceName * @param loader * @return diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/string/FlexibleStringExpander.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/string/FlexibleStringExpander.java index 64da2d6920..e176dadc52 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/string/FlexibleStringExpander.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/string/FlexibleStringExpander.java @@ -116,7 +116,8 @@ public abstract class FlexibleStringExpander implements Serializable, IsEmpty { * because it returns <code>null</code> when given a null <code>expression</code> * argument, and * <code>FlexibleStringExpander.getInstance(expression).expandString(context)</code> - * returns an empty <code>String</code>.</p> + * returns an empty <code>String</code>. + * * @param expression The original expression * @param context The evaluation context * @return The original expression's evaluation result as a <code>String</code> @@ -133,7 +134,8 @@ public abstract class FlexibleStringExpander implements Serializable, IsEmpty { * because it returns <code>null</code> when given a null <code>expression</code> * argument, and * <code>FlexibleStringExpander.getInstance(expression).expandString(context, locale)</code> - * returns an empty <code>String</code>.</p> + * returns an empty <code>String</code>. + * * @param expression The original expression * @param context The evaluation context * @param locale The locale to be used for localization @@ -151,7 +153,8 @@ public abstract class FlexibleStringExpander implements Serializable, IsEmpty { * because it returns <code>null</code> when given a null <code>expression</code> * argument, and * <code>FlexibleStringExpander.getInstance(expression).expandString(context, timeZone, locale)</code> - * returns an empty <code>String</code>.</p> + * returns an empty <code>String</code>. + * * @param expression The original expression * @param context The evaluation context * @param timeZone The time zone to be used for localization @@ -172,14 +175,16 @@ public abstract class FlexibleStringExpander implements Serializable, IsEmpty { /** Returns a <code>FlexibleStringExpander</code> object. <p>A null or * empty argument will return a <code>FlexibleStringExpander</code> * object that represents an empty expression. That object is a shared - * singleton, so there is no memory or performance penalty in using it.</p> + * singleton, so there is no memory or performance penalty in using it. + * * <p>If the method is passed a <code>String</code> argument that doesn't * contain an expression, the <code>FlexibleStringExpander</code> object * that is returned does not perform any evaluations on the original * <code>String</code> - any methods that return a <code>String</code> * will return the original <code>String</code>. The object returned by * this method is very compact - taking less memory than the original - * <code>String</code>.</p> + * <code>String</code>. + * * @param expression The original expression * @return A <code>FlexibleStringExpander</code> instance */ @@ -190,14 +195,16 @@ public abstract class FlexibleStringExpander implements Serializable, IsEmpty { /* Returns a <code>FlexibleStringExpander</code> object. <p>A null or * empty argument will return a <code>FlexibleStringExpander</code> * object that represents an empty expression. That object is a shared - * singleton, so there is no memory or performance penalty in using it.</p> + * singleton, so there is no memory or performance penalty in using it. + * * <p>If the method is passed a <code>String</code> argument that doesn't * contain an expression, the <code>FlexibleStringExpander</code> object * that is returned does not perform any evaluations on the original * <code>String</code> - any methods that return a <code>String</code> * will return the original <code>String</code>. The object returned by * this method is very compact - taking less memory than the original - * <code>String</code>.</p> + * <code>String</code>. + * * @param expression The original expression * @param useCache whether to store things into a global cache * @return A <code>FlexibleStringExpander</code> instance diff --git a/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java b/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java index cd34a35800..e019deb1c2 100644 --- a/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java +++ b/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java @@ -474,7 +474,8 @@ public final class UelUtil { /** Prepares an expression for evaluation by UEL.<p>The OFBiz syntax is * converted to UEL-compatible syntax and the resulting expression is - * returned.</p> + * returned. + * * @see <a href="StringUtil.html#convertOperatorSubstitutions(java.lang.String)">StringUtil.convertOperatorSubstitutions(java.lang.String)</a> * @param expression Expression to be converted * @return Converted expression diff --git a/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java b/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java index 7f60059647..cbf866c4f2 100644 --- a/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java +++ b/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java @@ -77,7 +77,8 @@ public final class PreferenceWorker { * is granted. * <p>Users can copy from any set of preferences to their own preferences. * Copying to another user's preferences requires <a href="#ADMIN_PERMISSION">ADMIN_PERMISSION</a> - * permission.</p> + * permission. + * * @param ctx The DispatchContext that this service is operating in. * @param context Map containing the input arguments. * @return Map with the result of the service, the output parameters. @@ -103,7 +104,8 @@ public final class PreferenceWorker { /** * Checks preference get/set permissions. Returns hasPermission=true if * permission is granted. - * <p>This method is a simple wrapper around the isValidxxxId methods.</p> + * <p>This method is a simple wrapper around the isValidxxxId methods. + * * @param ctx The DispatchContext that this service is operating in. * @param context Map containing the input arguments. * @return Map with the result of the service, the output parameters. @@ -158,7 +160,8 @@ public final class PreferenceWorker { * <p>This method searches the context Map for a userPrefLoginId key. If none is * found, the method attempts to get the current user's userLoginId. If the user * isn't logged in, then the method returns <a href="#DEFAULT_UID">DEFAULT_UID</a> - * if returnDefault is set to true, otherwise the method returns a null or empty string.</p> + * if returnDefault is set to true, otherwise the method returns a null or empty string. + * * @param context Map containing the input arguments. * @param returnDefault return <a href="#DEFAULT_UID">DEFAULT_UID</a> if no userLoginId is found. * @return userLoginId String diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java b/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java index bdd7a91252..49928adbc8 100644 --- a/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java +++ b/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java @@ -199,9 +199,11 @@ public interface Delegator { /** * <p>Create the Entities from the List GenericValue instances to the persistent - * store.</p> + * store. + * * <p>This is different than the normal create method, because all creation - * will be done with one unique insert to go fast.</p> + * will be done with one unique insert to go fast. + * * <p>For this reason eca can't be raised, so it's useful for process * with huge data to inject into database</p> * @param values @@ -211,11 +213,14 @@ public interface Delegator { /** * <p>Create the Entities from the List GenericValue instances to the persistent - * store.</p> + * store. + * * <p>This is different than the normal create method, because all creation - * will be done with one unique insert to go fast.</p> + * will be done with one unique insert to go fast. + * * <p>For this reason eca can't be raised, so it's useful for process - * with huge data to inject on database.</p> + * with huge data to inject on database. + * * <p>As this is a huge process, we can specify whether we want to alert the ofbiz cluster * if we need to clean their cache or just wait the normal expiration</p> * @param values @@ -757,16 +762,19 @@ public interface Delegator { void refreshSequencer(); /** - * <p>Remove the Entities from the List from the persistent store.</p> + * <p>Remove the Entities from the List from the persistent store. + * * <p>The List contains GenericEntity objects, can be either GenericPK or * GenericValue. </p> * <p>If a certain entity contains a complete primary key, the entity in * the datasource corresponding to that primary key will be removed, this - * is like a removeByPrimary Key.</p> + * is like a removeByPrimary Key. + * * <p>On the other hand, if a certain entity is an incomplete or non * primary key, if will behave like the removeByAnd method. </p> * <p>These updates all happen in one transaction, so they will either - * all succeed or all fail, if the data source supports transactions.</p> + * all succeed or all fail, if the data source supports transactions. + * * @param dummyPKs * Collection of GenericEntity instances containing the entities * or by and fields to remove @@ -870,15 +878,18 @@ public interface Delegator { /** * <p>Store the Entities from the List GenericValue instances to the persistent - * store.</p> + * store. + * * <p>This is different than the normal store method in that the * store method only does an update, while the storeAll method checks to see * if each entity exists, then either does an insert or an update as - * appropriate.</p> + * appropriate. + * * <p>These updates all happen in one transaction, so they * will either all succeed or all fail, if the data source supports * transactions. This is just like to othersToStore feature of the - * GenericEntity on a create or store.</p> + * GenericEntity on a create or store. + * * @param values * List of GenericValue instances containing the entities to * store @@ -888,15 +899,18 @@ public interface Delegator { /** * <p>Store the Entities from the List GenericValue instances to the persistent - * store.</p> + * store. + * * <p>This is different than the normal store method in that the * store method only does an update, while the storeAll method checks to see * if each entity exists, then either does an insert or an update as - * appropriate.</p> + * appropriate. + * * <p>These updates all happen in one transaction, so they * will either all succeed or all fail, if the data source supports * transactions. This is just like to othersToStore feature of the - * GenericEntity on a create or store.</p> + * GenericEntity on a create or store. + * * @param storeOptions * An instance of EntityStoreOptions that specifies advanced store * options or null for default values. diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/JdbcValueHandler.java b/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/JdbcValueHandler.java index 91b46c6294..114edcff1d 100644 --- a/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/JdbcValueHandler.java +++ b/framework/entity/src/main/java/org/apache/ofbiz/entity/jdbc/JdbcValueHandler.java @@ -744,7 +744,8 @@ public abstract class JdbcValueHandler<T> { * don't support sub-second precision. If the date-time field type * is a <code>CHAR(30)</code> SQL type, <code>java.sql.Timestamp</code>s * will be stored as JDBC timestamp escape format strings - * (<code>yyyy-mm-dd hh:mm:ss.fffffffff</code>), referenced to UTC.</p> + * (<code>yyyy-mm-dd hh:mm:ss.fffffffff</code>), referenced to UTC. + * */ protected static class TimestampJdbcValueHandler extends JdbcValueHandler<java.sql.Timestamp> { protected TimestampJdbcValueHandler(int jdbcType) { diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/serialize/XmlSerializer.java b/framework/entity/src/main/java/org/apache/ofbiz/entity/serialize/XmlSerializer.java index ce954005a7..9700d08f22 100644 --- a/framework/entity/src/main/java/org/apache/ofbiz/entity/serialize/XmlSerializer.java +++ b/framework/entity/src/main/java/org/apache/ofbiz/entity/serialize/XmlSerializer.java @@ -81,7 +81,8 @@ public class XmlSerializer { /** Deserialize a Java object from an XML string. <p>This method should be used with caution. * If the XML string contains a serialized <code>GenericValue</code> or <code>GenericPK</code> - * then it is possible to unintentionally corrupt the database.</p> + * then it is possible to unintentionally corrupt the database. + * * @param content the content * @param delegator the delegator * @return return a deserialized object from XML string @@ -107,7 +108,8 @@ public class XmlSerializer { /** Deserialize a Java object from a DOM <code>Document</code>. * <p>This method should be used with caution. If the DOM <code>Document</code> * contains a serialized <code>GenericValue</code> or <code>GenericPK</code> - * then it is possible to unintentionally corrupt the database.</p> + * then it is possible to unintentionally corrupt the database. + * * @param document the document * @param delegator the delegator * @return returns a deserialized object from a DOM document diff --git a/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityUtil.java b/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityUtil.java index bfbd36ce76..88091a830c 100644 --- a/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityUtil.java +++ b/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityUtil.java @@ -530,7 +530,8 @@ public final class EntityUtil { /** * Returns <code>true</code> if multi-tenant has been enabled. * <p>Multi-tenant features are enabled by setting the <code>multitenant</code> - * property in <code>general.properties</code> to "Y".</p> + * property in <code>general.properties</code> to "Y". + * */ public static boolean isMultiTenantEnabled() { return "Y".equalsIgnoreCase(UtilProperties.getPropertyValue("general", "multitenant")); diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java index 3dc093baaa..daea4b0bad 100644 --- a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java +++ b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java @@ -279,7 +279,8 @@ public final class SimpleMethod extends MiniLangElement { * Returns a List of <code>SimpleMethod</code> objects compiled from <code>xmlResource</code>. * The ordering in the List is the same as the XML file. * <p>This method is used by unit test framework to run tests in the order they appear in the XML file. - * Method caching is bypassed since the methods are executed only once.</p> + * Method caching is bypassed since the methods are executed only once. + * * @param xmlResource * @param loader * @return diff --git a/framework/service/src/main/java/org/apache/ofbiz/service/calendar/TemporalExpressionWorker.java b/framework/service/src/main/java/org/apache/ofbiz/service/calendar/TemporalExpressionWorker.java index 03574cc5bc..4bb6f5757e 100644 --- a/framework/service/src/main/java/org/apache/ofbiz/service/calendar/TemporalExpressionWorker.java +++ b/framework/service/src/main/java/org/apache/ofbiz/service/calendar/TemporalExpressionWorker.java @@ -81,7 +81,8 @@ public final class TemporalExpressionWorker { /** Create a <code>TemporalExpression</code> instance from a TemporalExpression * GenericValue.<p>This method makes recursive calls, so care must be taken to - * avoid endless loops.</p> + * avoid endless loops. + * * @param delegator * @param exprValue * @return A <code>TemporalExpression</code> instance based on <code>exprValue</code> diff --git a/framework/webapp/src/main/java/org/apache/ofbiz/webapp/webdav/WebDavUtil.java b/framework/webapp/src/main/java/org/apache/ofbiz/webapp/webdav/WebDavUtil.java index 1cee7dcdcb..ee61077b76 100644 --- a/framework/webapp/src/main/java/org/apache/ofbiz/webapp/webdav/WebDavUtil.java +++ b/framework/webapp/src/main/java/org/apache/ofbiz/webapp/webdav/WebDavUtil.java @@ -68,7 +68,8 @@ public final class WebDavUtil { * intended to be used as parameters for the <code>userLogin</code> service. <p>The method * checks for the request parameters <code>USERNAME</code> and <code>PASSWORD</code>. If * those aren't found, then the request is checked for the HTTP Authorization header. - * Currently, only Basic authorization is supported.</p> + * Currently, only Basic authorization is supported. + * * @param request The WebDAV request * @return A <code>Map</code> containing <code>login.username</code> and * <code>login.password</code> elements. diff --git a/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetFactory.java b/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetFactory.java index 3db689874e..11f7b0c445 100644 --- a/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetFactory.java +++ b/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetFactory.java @@ -117,7 +117,8 @@ public final class WidgetFactory { * Registers a screen sub-widget with the factory. If a tag name is already * registered, the new widget replaces the existing one.<p>The class supplied * to the method must have a public two-argument constructor that takes a - * <code>ModelScreen</code> instance and an <code>Element</code> instance.</p> + * <code>ModelScreen</code> instance and an <code>Element</code> instance. + * * @param tagName The XML element tag name for this widget * @param widgetClass The class that implements the widget element * @throws SecurityException diff --git a/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetLoader.java b/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetLoader.java index 6b04466657..1a30903b6f 100644 --- a/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetLoader.java +++ b/framework/widget/src/main/java/org/apache/ofbiz/widget/WidgetLoader.java @@ -29,7 +29,8 @@ public interface WidgetLoader { /** * Registers screen widgets with the widget factory.<p>Implementations register * screen widget classes by calling the <code>WidgetFactory registerXxxx</code> - * methods.</p> + * methods. + * */ void loadWidgets();