svn commit: r1774815 - in /ofbiz/trunk: applications/content/src/main/
Locked
svn commit: r1774815 - in /ofbiz/trunk: applications/content/src/main/
 
|
Author: mbrohl
Date: Sat Dec 17 23:34:51 2016 New Revision: 1774815 URL: http://svn.apache.org/viewvc?rev=1774815&view=rev Log: Improved: refactor javadocs in OFBiz to be standards compliant (OFBIZ-9144) Modified: ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/survey/PdfSurveyServices.java ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReadHelper.java ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReturnServices.java ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/ShoppingCartEvents.java ofbiz/trunk/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/location/FlexibleLocation.java ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelFunctions.java ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericEntity.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericPK.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericValue.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityCondition.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionBase.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionVisitor.java ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/JSONRequestBodyMapHandler.java ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/RequestBodyMapHandler.java ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/ScriptEventHandler.java ofbiz/trunk/specialpurpose/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatEvents.java ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatEvents.java ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatParser.java Modified: ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/survey/PdfSurveyServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/survey/PdfSurveyServices.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/survey/PdfSurveyServices.java (original) +++ ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/survey/PdfSurveyServices.java Sat Dec 17 23:34:51 2016 @@ -455,7 +455,7 @@ public class PdfSurveyServices { } /** - * Returns list of maps with "question"->SurveyQuestion and "response"->SurveyResponseAnswer + * Returns list of maps with "question" -> SurveyQuestion and "response" -> SurveyResponseAnswer */ public static Map<String, Object> buildSurveyQuestionsAndAnswers(DispatchContext dctx, Map<String, ? extends Object> context) { Delegator delegator = dctx.getDelegator(); Modified: ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java (original) +++ ofbiz/trunk/applications/content/src/main/java/org/apache/ofbiz/content/webapp/ftl/RenderSubContentTransform.java Sat Dec 17 23:34:51 2016 @@ -53,11 +53,10 @@ public class RenderSubContentTransform i /** * @deprecated use FreeMarkerWorker.getArg() - * 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/> - * Note that this is different from the getArg method of EditRenderDataResourceTransform, which checks the request object instead of the template context - * object. + * <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> + * <p>Note that this is different from the getArg method of EditRenderDataResourceTransform, which checks the request object instead of the template context + * object.</p> */ @Deprecated public static String getArg(Map<String, Object> args, String key, Environment env) { Modified: ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReadHelper.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReadHelper.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReadHelper.java (original) +++ ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReadHelper.java Sat Dec 17 23:34:51 2016 @@ -207,8 +207,8 @@ public class OrderReadHelper { } /** - * Returns a Map of paymentMethodId -> amount charged (BigDecimal) based on PaymentGatewayResponse. - * @return returns a Map of paymentMethodId -> amount charged (BigDecimal) based on PaymentGatewayResponse. + * Returns a Map of paymentMethodId -> amount charged (BigDecimal) based on PaymentGatewayResponse. + * @return returns a Map of paymentMethodId -> amount charged (BigDecimal) based on PaymentGatewayResponse. */ public Map<String, BigDecimal> getReceivedPaymentTotalsByPaymentMethod() { Map<String, BigDecimal> paymentMethodAmounts = new HashMap<String, BigDecimal>(); @@ -252,8 +252,8 @@ public class OrderReadHelper { } /** - * Returns a Map of paymentMethodId -> amount refunded - * @return returns a Map of paymentMethodId -> amount refunded + * Returns a Map of paymentMethodId -> amount refunded + * @return returns a Map of paymentMethodId -> amount refunded */ public Map<String, BigDecimal> getReturnedTotalsByPaymentMethod() { Map<String, BigDecimal> paymentMethodAmounts = new HashMap<String, BigDecimal>(); @@ -2720,7 +2720,7 @@ public class OrderReadHelper { } /** - * Get the total return adjustments for a set of key -> value condition pairs. Done for code efficiency. + * Get the total return adjustments for a set of key -> value condition pairs. Done for code efficiency. * @param delegator the delegator * @param condition a map of the conditions to use * @return Get the total return adjustments Modified: ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReturnServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReturnServices.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReturnServices.java (original) +++ ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderReturnServices.java Sat Dec 17 23:34:51 2016 @@ -2188,7 +2188,7 @@ public class OrderReturnServices { } /** - * Takes a List of returnItems and returns a Map of orderId -> items and a Map of orderId -> orderTotal + * Takes a List of returnItems and returns a Map of orderId -> items and a Map of orderId -> orderTotal * @param returnItems a List of return items * @param returnItemsByOrderId the return items by order id * @param totalByOrder the total by order id @@ -2548,7 +2548,7 @@ public class OrderReturnServices { } /** - * Get the total return adjustments for a set of key -> value condition pairs. Done for code efficiency. + * Get the total return adjustments for a set of key -> value condition pairs. Done for code efficiency. * @param delegator the delegator * @param condition the conditions to use * @return return the total return adjustments Modified: ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java (original) +++ ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java Sat Dec 17 23:34:51 2016 @@ -5688,10 +5688,9 @@ public class OrderServices { /** * Create an OrderItemShipGroup record - * @param ctx + * @param dctx * @param context * @return - * @throws GenericEntityException */ public static Map<String, Object> addOrderItemShipGroup(DispatchContext dctx, Map<String, Object> context) { Delegator delegator = dctx.getDelegator(); @@ -5896,7 +5895,7 @@ public class OrderServices { /** * Update orderItem and shipgroup association - * @param ctx + * @param dctx * @param context * @return * @throws GeneralException Modified: ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/ShoppingCartEvents.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/ShoppingCartEvents.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/ShoppingCartEvents.java (original) +++ ofbiz/trunk/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/ShoppingCartEvents.java Sat Dec 17 23:34:51 2016 @@ -967,7 +967,7 @@ public class ShoppingCartEvents { return cart; } - /** Main get cart method; uses the locale & currency from the session */ + /** Main get cart method, uses the locale and currency from the session */ public static ShoppingCart getCartObject(HttpServletRequest request) { return getCartObject(request, null, null); } Modified: ofbiz/trunk/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java (original) +++ ofbiz/trunk/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java Sat Dec 17 23:34:51 2016 @@ -484,12 +484,13 @@ public class CatalogUrlSeoTransform impl /** * Forward a uri according to forward pattern regular expressions. - * - * @param uri - * String to reverse transform + * @param request + * @param response + * @param delegator + * @param controlServlet * @return boolean to indicate whether the uri is forwarded. - * @throws IOException * @throws ServletException + * @throws IOException */ public static boolean forwardUri(HttpServletRequest request, HttpServletResponse response, Delegator delegator, String controlServlet) throws ServletException, IOException { String pathInfo = request.getRequestURI(); @@ -605,12 +606,13 @@ public class CatalogUrlSeoTransform impl /** * Forward a category uri according to forward pattern regular expressions. - * - * @param uri - * String to reverse transform - * @return String - * @throws IOException + * @param request + * @param response + * @param delegator + * @param controlServlet + * @return * @throws ServletException + * @throws IOException */ public static boolean forwardCategoryUri(HttpServletRequest request, HttpServletResponse response, Delegator delegator, String controlServlet) throws ServletException, IOException { String pathInfo = request.getRequestURI(); @@ -668,7 +670,7 @@ public class CatalogUrlSeoTransform impl * @param wrapper * @param prefix * @param contextPath - * @param productCategoryId + * @param currentCategoryId * @param previousCategoryId * @param productId * @return @@ -755,7 +757,7 @@ public class CatalogUrlSeoTransform impl * @param delegator * @param wrapper * @param prefix - * @param productCategoryId + * @param currentCategoryId * @param previousCategoryId * @param productId * @param viewSize Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/location/FlexibleLocation.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/location/FlexibleLocation.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/location/FlexibleLocation.java (original) +++ ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/location/FlexibleLocation.java Sat Dec 17 23:34:51 2016 @@ -88,7 +88,7 @@ public final class FlexibleLocation { * * The general format of the location is like a URL: {locationType}://location/path/file.ext * - * Supports standard locationTypes like http, https, ftp, jar, & file + * Supports standard locationTypes like http, https, ftp, jar and file * Supports a classpath location type for when desired to be used like any other URL * Supports OFBiz specific location types like ofbizhome and component * Supports additional locationTypes specified in the locationresolvers.properties file Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelFunctions.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelFunctions.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelFunctions.java (original) +++ ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelFunctions.java Sat Dec 17 23:34:51 2016 @@ -49,7 +49,7 @@ import org.w3c.dom.Node; /** Implements Unified Expression Language functions. * <p>Built-in functions are divided into a number of * namespace prefixes:</p> - * <table border="1"> + * <table border="1" summary=""> * <tr><td colspan="2"><b><code>date:</code> contains miscellaneous date/time functions</b></td></tr> * <tr><td><code>date:second(Timestamp, TimeZone, Locale)</code></td><td>Returns the second value of <code>Timestamp</code> (0 - 59).</td></tr> * <tr><td><code>date:minute(Timestamp, TimeZone, Locale)</code></td><td>Returns the minute value of <code>Timestamp</code> (0 - 59).</td></tr> Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java (original) +++ ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/string/UelUtil.java Sat Dec 17 23:34:51 2016 @@ -72,7 +72,6 @@ public final class UelUtil { * @param context Evaluation context (variables) * @param expression UEL expression * @return Result object - * @throws <code>javax.el.*</code> exceptions */ public static Object evaluate(Map<String, ? extends Object> context, String expression) { return evaluate(context, expression, Object.class); @@ -83,7 +82,6 @@ public final class UelUtil { * @param expression UEL expression * @param expectedType The expected object Class to return * @return Result object - * @throws <code>javax.el.*</code> exceptions */ public static Object evaluate(Map<String, ? extends Object> context, String expression, Class expectedType) { ELContext elContext = new ReadOnlyContext(context); @@ -96,7 +94,6 @@ public final class UelUtil { * @param context Evaluation context (variables) * @param expression UEL expression * @param expectedType The expected object Class to set - * @throws <code>javax.el.*</code> exceptions */ public static void setValue(Map<String, Object> context, String expression, Class expectedType, Object value) { if (Debug.verboseOn()) { @@ -111,7 +108,6 @@ public final class UelUtil { * to null. * @param context Evaluation context (variables) * @param expression UEL expression - * @throws <code>javax.el.*</code> exceptions */ public static void removeValue(Map<String, Object> context, String expression) { if (Debug.verboseOn()) { Modified: ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java (original) +++ ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/preferences/PreferenceWorker.java Sat Dec 17 23:34:51 2016 @@ -180,7 +180,7 @@ public final class PreferenceWorker { /** * Checks for valid userLoginId to get preferences. Returns true if valid. * <p>This method applies a small rule set to determine if user preferences - * can be retrieved by the current user: + * can be retrieved by the current user:</p> * <ul> * <li>If the user isn't logged in, then the method returns true</li> * <li>If the user is logged in and the userPrefLoginId specified in the context Map @@ -189,7 +189,7 @@ public final class PreferenceWorker { * is different than the user's userLoginId, then a security permission check is performed. * If the user has the <a href="#ADMIN_PERMISSION">ADMIN_PERMISSION</a> permission then the * method returns true.</li> - * </ul></p> + * </ul> * * @param ctx The DispatchContext that this service is operating in. * @param context Map containing the input arguments. @@ -215,7 +215,7 @@ public final class PreferenceWorker { /** * Checks for valid userLoginId to set preferences. Returns true if valid. * <p>This method applies a small rule set to determine if user preferences - * can be set by the current user: + * can be set by the current user:</p> * <ul> * <li>If the user isn't logged in, then the method returns false</li> * <li>If the user is logged in and the userPrefLoginId specified in the context Map @@ -224,7 +224,7 @@ public final class PreferenceWorker { * is different than the user's userLoginId, then a security permission check is performed. * If the user has the <a href="#ADMIN_PERMISSION">ADMIN_PERMISSION</a> * permission then the method returns true.</li> - * </ul></p> + * </ul> * @param ctx The DispatchContext that this service is operating in. * @param context Map containing the input arguments. * @return true if arguments are valid Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/Delegator.java Sat Dec 17 23:34:51 2016 @@ -503,11 +503,10 @@ public interface Delegator { ModelEntity getModelEntity(String entityName); /** - * Gets a Map of entity name & entity model pairs that are in the named + * Gets a Map of entity name and entity model pairs that are in the named * group * - * @param groupName - * The name of the group + * @param groupName The name of the group * @return Map of entityName String keys and ModelEntity instance values */ Map<String, ModelEntity> getModelEntityMapByGroup(String groupName) throws GenericEntityException; @@ -739,15 +738,16 @@ public interface Delegator { void refreshSequencer(); /** - * Remove the Entities from the List from the persistent store. <br/>The - * List contains GenericEntity objects, can be either GenericPK or - * GenericValue. <br/>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. <br/>On the other hand, if a - * certain entity is an incomplete or non primary key, if will behave like - * the removeByAnd method. <br/>These updates all happen in one transaction, - * so they will either all succeed or all fail, if the data source supports - * transactions. + * <p>Remove the Entities from the List from the persistent store.</p> + * <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> + * <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> * * @param dummyPKs * Collection of GenericEntity instances containing the entities @@ -858,14 +858,16 @@ public interface Delegator { int store(GenericValue value) throws GenericEntityException; /** - * Store the Entities from the List GenericValue instances to the persistent - * store. <br/>This is different than the normal store method in that the + * <p>Store the Entities from the List GenericValue instances to the persistent + * store.</p> + * <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. <br/>These updates all happen in one transaction, so they + * appropriate.</p> + * <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. + * GenericEntity on a create or store.</p> * * @param values * List of GenericValue instances containing the entities to @@ -875,14 +877,16 @@ public interface Delegator { int storeAll(List<GenericValue> values) throws GenericEntityException; /** - * Store the Entities from the List GenericValue instances to the persistent - * store. <br/>This is different than the normal store method in that the + * <p>Store the Entities from the List GenericValue instances to the persistent + * store.</p> + * <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. <br/>These updates all happen in one transaction, so they + * appropriate.</p> + * <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. + * GenericEntity on a create or store.</p> * * @param storeOptions * An instance of EntityStoreOptions that specifies advanced store @@ -896,7 +900,7 @@ public interface Delegator { int storeAll(List<GenericValue> values, EntityStoreOptions storeOptions) throws GenericEntityException; /** - * Store a group of values + * Store a group of values. * * @param entityName * The name of the Entity as defined in the entity XML file Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericEntity.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericEntity.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericEntity.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericEntity.java Sat Dec 17 23:34:51 2016 @@ -759,7 +759,7 @@ public class GenericEntity implements Ma * definition as the resource name. To specify a resource name manually, use the other getResource method. * * So, the key in the resource bundle (properties file) should be as follows: - * <entity-name>.<field-name>.<pk-field-value-1>.<pk-field-value-2>...<pk-field-value-n> + * <entity-name>.<field-name>.<pk-field-value-1>.<pk-field-value-2>...<pk-field-value-n> * For example: * ProductType.description.FINISHED_GOOD * @@ -1419,8 +1419,8 @@ public class GenericEntity implements Ma return tempResult; } - /** Clones this GenericEntity, this is a shallow clone & uses the default shallow HashMap clone - *@return Object that is a clone of this GenericEntity + /** Clones this GenericEntity, this is a shallow clone and uses the default shallow HashMap clone + * @return Object that is a clone of this GenericEntity */ @Override public Object clone() { Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericPK.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericPK.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericPK.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericPK.java Sat Dec 17 23:34:51 2016 @@ -67,8 +67,8 @@ public class GenericPK extends GenericEn return false; } - /** Clones this GenericPK, this is a shallow clone & uses the default shallow HashMap clone - *@return Object that is a clone of this GenericPK + /** Clones this GenericPK, this is a shallow clone and uses the default shallow HashMap clone + * @return Object that is a clone of this GenericPK */ @Override public Object clone() { Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericValue.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericValue.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericValue.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/GenericValue.java Sat Dec 17 23:34:51 2016 @@ -223,8 +223,8 @@ public class GenericValue extends Generi return false; } - /** Clones this GenericValue, this is a shallow clone & uses the default shallow HashMap clone - *@return Object that is a clone of this GenericValue + /** Clones this GenericValue, this is a shallow clone and uses the default shallow HashMap clone + * @return Object that is a clone of this GenericValue */ @Override public Object clone() { Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityCondition.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityCondition.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityCondition.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityCondition.java Sat Dec 17 23:34:51 2016 @@ -31,8 +31,8 @@ import org.apache.ofbiz.entity.config.mo import org.apache.ofbiz.entity.model.ModelEntity; /** - * Represents the conditions to be used to constrain a query - * <br/>An EntityCondition can represent various type of constraints, including: + * <p>Represents the conditions to be used to constrain a query.</p> + * <p>An EntityCondition can represent various type of constraints, including:</p> * <ul> * <li>EntityConditionList: a list of EntityConditions, combined with the operator specified * <li>EntityExpr: for simple expressions or expressions that combine EntityConditions Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionBase.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionBase.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionBase.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionBase.java Sat Dec 17 23:34:51 2016 @@ -32,8 +32,8 @@ import org.apache.ofbiz.entity.model.Mod import org.apache.ofbiz.entity.model.ModelViewEntity.ModelAlias; /** - * Represents the conditions to be used to constrain a query - * <br/>An EntityCondition can represent various type of constraints, including: + * <p>Represents the conditions to be used to constrain a query.</p> + * <p>An EntityCondition can represent various type of constraints, including:</p> * <ul> * <li>EntityConditionList: a list of EntityConditions, combined with the operator specified * <li>EntityExpr: for simple expressions or expressions that combine EntityConditions Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionVisitor.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionVisitor.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionVisitor.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/condition/EntityConditionVisitor.java Sat Dec 17 23:34:51 2016 @@ -22,8 +22,8 @@ package org.apache.ofbiz.entity.conditio import java.util.List; /** - * Represents the conditions to be used to constrain a query - * <br/>An EntityCondition can represent various type of constraints, including: + * <p>Represents the conditions to be used to constrain a query.</p> + * <p>An EntityCondition can represent various type of constraints, including:</p> * <ul> * <li>EntityConditionList: a list of EntityConditions, combined with the operator specified * <li>EntityExpr: for simple expressions or expressions that combine EntityConditions Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java (original) +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java Sat Dec 17 23:34:51 2016 @@ -71,16 +71,14 @@ public class EntityQuery { /** Construct an EntityQuery object for use against the specified Delegator - * @param delegator - The delegator instance to use for the query - * @return Returns a new EntityQuery object + * @param delegator The delegator instance to use for the query */ public static EntityQuery use(Delegator delegator) { return new EntityQuery(delegator); } /** Construct an EntityQuery object for use against the specified Delegator - * @param delegator - The delegator instance to use for the query - * @return Returns a new EntityQuery object + * @param delegator The delegator instance to use for the query */ public EntityQuery(Delegator delegator) { this.delegator = delegator; Modified: ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/JSONRequestBodyMapHandler.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/JSONRequestBodyMapHandler.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/JSONRequestBodyMapHandler.java (original) +++ ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/JSONRequestBodyMapHandler.java Sat Dec 17 23:34:51 2016 @@ -25,7 +25,7 @@ import javax.servlet.ServletRequest; import java.io.IOException; import java.util.Map; -/** An implementation of <code>RequestBodyMapHandler</code> that can extract a <code>Map<String, Object></code> from the JSON data in the request body */ +/** An implementation of <code>RequestBodyMapHandler</code> that can extract a <code>Map<String, Object></code> from the JSON data in the request body */ public class JSONRequestBodyMapHandler implements RequestBodyMapHandler { public Map<String, Object> extractMapFromRequestBody(ServletRequest request) throws IOException { Modified: ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/RequestBodyMapHandler.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/RequestBodyMapHandler.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/RequestBodyMapHandler.java (original) +++ ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/RequestBodyMapHandler.java Sat Dec 17 23:34:51 2016 @@ -24,10 +24,10 @@ import java.util.Map; /** An handler that can extract a Map (typically used as a service input map) from the data in the body of a <code>ServletRequest</code>. */ public interface RequestBodyMapHandler { - /** Extracts from the data in the body of the <code>ServletRequest</code> an instance of <code>Map<String, Object></code>. + /** Extracts from the data in the body of the <code>ServletRequest</code> an instance of <code>Map<String, Object></code>. * * @param request the request with the data in its body - * @return an instance of <code>Map<String, Object></code> that represents the data in the request body + * @return an instance of <code>Map<String, Object></code> that represents the data in the request body */ public Map<String, Object> extractMapFromRequestBody(ServletRequest request) throws IOException; } Modified: ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/ScriptEventHandler.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/ScriptEventHandler.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/ScriptEventHandler.java (original) +++ ofbiz/trunk/framework/webapp/src/main/java/org/apache/ofbiz/webapp/event/ScriptEventHandler.java Sat Dec 17 23:34:51 2016 @@ -39,7 +39,7 @@ import org.apache.ofbiz.webapp.control.C /** * Generic Script Event Handler. This event handler uses the javax.script package (JSR-223) to invoke scripts or script functions. - * <p>The script event handler will put the following artifacts in the script engine's bindings:<br /> + * <p>The script event handler will put the following artifacts in the script engine's bindings:</p> * <ul> * <li><code>parameters</code> - a <code>Map</code> containing servlet context, session, request attributes and parameters</li> * <li><code>request</code> - a <code>HttpServletRequest</code> instance</li> @@ -51,7 +51,7 @@ import org.apache.ofbiz.webapp.control.C * <li><code>locale</code> - a <code>Locale</code> instance</li> * <li><code>timeZone</code> - a <code>TimeZone</code> instance</li> * <li><code>userLogin</code> - a UserLogin <code>GenericValue</code></li> - * </ul></p> + * </ul> * <p>If the event element includes an invoke attribute, then the matching script function/method will be called * with a single argument - the bindings <code>Map</code>.</p> */ Modified: ofbiz/trunk/specialpurpose/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/specialpurpose/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java (original) +++ ofbiz/trunk/specialpurpose/ldap/src/main/java/org/apache/ofbiz/ldap/commons/InterfaceOFBizAuthenticationHandler.java Sat Dec 17 23:34:51 2016 @@ -72,7 +72,6 @@ public interface InterfaceOFBizAuthentic * @param rootElement Element root element of ldap config file * * @return success if the user can login successfully; otherwise, error. - * @throws Exception */ String logout(HttpServletRequest request, HttpServletResponse response, Element rootElement); @@ -85,7 +84,7 @@ public interface InterfaceOFBizAuthentic * @param bindRequired boolean if true, bind; false, just search the user in LDAP * * @return result SearchResult if ldap search successfully; otherwise, null. - * @throws Exception + * @throws NamingException */ SearchResult getLdapSearchResult(String username, String password, Element rootElement, boolean bindRequired) throws NamingException; Modified: ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java (original) +++ ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/htmlreport/util/ReportEncoder.java Sat Dec 17 23:34:51 2016 @@ -426,7 +426,7 @@ public final class ReportEncoder { * entity representation, for example & becomes &#38;.<p> * * A character <code>num</code> is replaced if<br> - * <code>((ch != 32) && ((ch > 122) || (ch < 48) || (ch == 60) || (ch == 62)))</code><p> + * <code>((ch != 32) && ((ch > 122) || (ch < 48) || (ch == 60) || (ch == 62)))</code><p> * * @param source the String to escape * @@ -471,7 +471,7 @@ public final class ReportEncoder { * entity representation, for example & becomes &#38;.<p> * * A character <code>num</code> is replaced if<br> - * <code>(ch > 255)</code><p> + * <code>(ch > 255)</code><p> * * @param source the String to escape * Modified: ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatEvents.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatEvents.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatEvents.java (original) +++ ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatEvents.java Sat Dec 17 23:34:51 2016 @@ -30,7 +30,6 @@ import javax.servlet.http.HttpServletReq import javax.servlet.http.HttpServletResponse; import org.apache.commons.fileupload.servlet.ServletFileUpload; -import org.jdom.JDOMException; import org.apache.ofbiz.base.location.ComponentLocationResolver; import org.apache.ofbiz.base.util.Debug; import org.apache.ofbiz.base.util.FileUtil; @@ -61,8 +60,6 @@ public class PricatEvents { * @param request * @param response * @return - * @throws IOException - * @throws JDOMException */ public static String downloadExcelTemplate(HttpServletRequest request, HttpServletResponse response) { String templateType = request.getParameter("templateType"); @@ -144,8 +141,6 @@ public class PricatEvents { * @param request * @param response * @return - * @throws IOException - * @throws JDOMException */ public static String downloadCommentedExcel(HttpServletRequest request, HttpServletResponse response) { String sequenceNum = request.getParameter("sequenceNum"); Modified: ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java (original) +++ ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/PricatParseExcelHtmlReport.java Sat Dec 17 23:34:51 2016 @@ -37,8 +37,8 @@ public class PricatParseExcelHtmlReport /** * Public constructor with report variables.<p> * - * @param req the HttpServletRequest request - * @param res the HttpServletResponse response + * @param request the HttpServletRequest request + * @param response the HttpServletResponse response */ public PricatParseExcelHtmlReport(HttpServletRequest request, HttpServletResponse response) { Modified: ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatEvents.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatEvents.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatEvents.java (original) +++ ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatEvents.java Sat Dec 17 23:34:51 2016 @@ -28,7 +28,6 @@ import java.nio.file.Paths; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; -import org.jdom.JDOMException; import org.apache.ofbiz.base.location.ComponentLocationResolver; import org.apache.ofbiz.base.util.Debug; import org.apache.ofbiz.base.util.UtilHttp; @@ -52,8 +51,6 @@ public class SamplePricatEvents extends * @param request * @param response * @return - * @throws IOException - * @throws JDOMException */ public static String downloadExcelTemplate(HttpServletRequest request, HttpServletResponse response) { String templateType = request.getParameter("templateType"); Modified: ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatParser.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatParser.java?rev=1774815&r1=1774814&r2=1774815&view=diff ============================================================================== --- ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatParser.java (original) +++ ofbiz/trunk/specialpurpose/pricat/src/main/java/org/apache/ofbiz/pricat/sample/SamplePricatParser.java Sat Dec 17 23:34:51 2016 @@ -236,7 +236,6 @@ public class SamplePricatParser extends * * @param row * @param cellContents - * @param document * @return * @throws GenericTransactionException */ |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |