This is an automated email from the ASF dual-hosted git repository.
surajk pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 0af165fb08973a29e52840e5355a9b1d00e36fc0
Author: Suraj Khurana <suraj.khur...@hotwax.co>
AuthorDate: Sun Sep 13 11:29:10 2020 +0530
Improved: Added missing Javadocs for remaining methods in applications
component, this is required for all classes which looks like designed for
extension (can be subclassed).
(OFBIZ-11947)
Thanks Jacques for review.
---
.../org/apache/ofbiz/order/shoppingcart/CheckOutHelper.java | 3 +++
.../product/category/ftl/CatalogAltUrlSeoTransform.java | 13 +++++++++++++
.../ofbiz/product/category/ftl/CatalogUrlSeoTransform.java | 6 ++++++
.../product/category/ftl/OfbizCatalogUrlTransform.java | 6 ++++++
.../org/apache/ofbiz/product/category/ftl/SeoTransform.java | 7 +++++++
.../ofbiz/product/category/ftl/UrlRegexpTransform.java | 7 +++++++
.../org/apache/ofbiz/product/product/ProductSearch.java | 5 +++++
.../ofbiz/workeffort/workeffort/ICalRecurConverter.java | 5 +++++
8 files changed, 52 insertions(+)
diff --git
a/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/CheckOutHelper.java
b/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/CheckOutHelper.java
index 12edfb4..75a3433 100644
---
a/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/CheckOutHelper.java
+++
b/applications/order/src/main/java/org/apache/ofbiz/order/shoppingcart/CheckOutHelper.java
@@ -1889,6 +1889,9 @@ public class CheckOutHelper {
return ServiceUtil.returnSuccess();
}
+ /**
+ * Validate gift card amounts.
+ */
public void validateGiftCardAmounts() {
// get the product store
GenericValue productStore =
ProductStoreWorker.getProductStore(cart.getProductStoreId(), delegator);
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogAltUrlSeoTransform.java
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogAltUrlSeoTransform.java
index b6d544f..61ad409 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogAltUrlSeoTransform.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogAltUrlSeoTransform.java
@@ -54,6 +54,12 @@ import freemarker.template.TemplateTransformModel;
public class CatalogAltUrlSeoTransform implements TemplateTransformModel {
private static final String MODULE =
CatalogUrlSeoTransform.class.getName();
+ /**
+ * Gets string arg.
+ * @param args the args
+ * @param key the key
+ * @return the string arg
+ */
public String getStringArg(Map<?, ?> args, String key) {
Object o = args.get(key);
if (o instanceof SimpleScalar) {
@@ -68,6 +74,13 @@ public class CatalogAltUrlSeoTransform implements
TemplateTransformModel {
return null;
}
+ /**
+ * Check arg boolean.
+ * @param args the args
+ * @param key the key
+ * @param defaultValue the default value
+ * @return the boolean
+ */
public boolean checkArg(Map<?, ?> args, String key, boolean defaultValue) {
if (!args.containsKey(key)) {
return defaultValue;
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java
index 679c151..797b217 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/CatalogUrlSeoTransform.java
@@ -85,6 +85,12 @@ public class CatalogUrlSeoTransform implements
TemplateTransformModel {
}
}
+ /**
+ * Gets string arg.
+ * @param args the args
+ * @param key the key
+ * @return the string arg
+ */
public String getStringArg(Map<?, ?> args, String key) {
Object o = args.get(key);
if (o instanceof SimpleScalar) {
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/OfbizCatalogUrlTransform.java
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/OfbizCatalogUrlTransform.java
index 4e225b3..40781b4 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/OfbizCatalogUrlTransform.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/OfbizCatalogUrlTransform.java
@@ -36,6 +36,12 @@ import freemarker.template.TemplateTransformModel;
public class OfbizCatalogUrlTransform implements TemplateTransformModel {
private static final String MODULE =
OfbizCatalogUrlTransform.class.getName();
+ /**
+ * Gets string arg.
+ * @param args the args
+ * @param key the key
+ * @return the string arg
+ */
public String getStringArg(Map<?, ?> args, String key) {
Object o = args.get(key);
if (o instanceof SimpleScalar) {
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/SeoTransform.java
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/SeoTransform.java
index 46dac1a..a3ae56c 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/SeoTransform.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/SeoTransform.java
@@ -49,6 +49,13 @@ public class SeoTransform implements TemplateTransformModel {
private static final String MODULE = SeoTransform.class.getName();
+ /**
+ * Check arg boolean.
+ * @param args the args
+ * @param key the key
+ * @param defaultValue the default value
+ * @return the boolean
+ */
public boolean checkArg(Map<?, ?> args, String key, boolean defaultValue) {
if (!args.containsKey(key)) {
return defaultValue;
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/UrlRegexpTransform.java
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/UrlRegexpTransform.java
index 39b77de..336ce71 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/UrlRegexpTransform.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/category/ftl/UrlRegexpTransform.java
@@ -79,6 +79,13 @@ public class UrlRegexpTransform implements
TemplateTransformModel {
return result;
}
+ /**
+ * Check arg boolean.
+ * @param args the args
+ * @param key the key
+ * @param defaultValue the default value
+ * @return the boolean
+ */
public boolean checkArg(Map<?, ?> args, String key, boolean defaultValue) {
if (!args.containsKey(key)) {
return defaultValue;
diff --git
a/applications/product/src/main/java/org/apache/ofbiz/product/product/ProductSearch.java
b/applications/product/src/main/java/org/apache/ofbiz/product/product/ProductSearch.java
index 06573be..2404ed6 100644
---
a/applications/product/src/main/java/org/apache/ofbiz/product/product/ProductSearch.java
+++
b/applications/product/src/main/java/org/apache/ofbiz/product/product/ProductSearch.java
@@ -1812,6 +1812,11 @@ public class ProductSearch {
}
}
+ /**
+ * Make full keyword set set.
+ * @param delegator the delegator
+ * @return the set
+ */
public Set<String> makeFullKeywordSet(Delegator delegator) {
Set<String> keywordSet =
KeywordSearchUtil.makeKeywordSet(this.keywordsString, null, true);
Set<String> fullKeywordSet = new TreeSet<>();
diff --git
a/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/ICalRecurConverter.java
b/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/ICalRecurConverter.java
index dab55a8..cf7460f 100644
---
a/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/ICalRecurConverter.java
+++
b/applications/workeffort/src/main/java/org/apache/ofbiz/workeffort/workeffort/ICalRecurConverter.java
@@ -97,6 +97,11 @@ public class ICalRecurConverter implements
TemporalExpressionVisitor {
protected ICalRecurConverter() { }
+ /**
+ * Consolidate recurs recur.
+ * @param recurList the recur list
+ * @return the recur
+ */
@SuppressWarnings("unchecked")
protected Recur consolidateRecurs(List<Recur> recurList) {
// Try to consolidate a list of Recur instances into one instance
