update javadocs issues

Author: wildone

aemdesign-aem-services/src/main/java/design/aem/models/v2/details/ContactDetails.java

@@ -122,8 +122,8 @@ protected void ready() {
     /***
      * substitute formatted field template with fields from component
      * @param componentProperties source map with fields
-     * @param i18n
-     * @param sling
+     * @param i18n i18n instance
+     * @param sling sling instance
      * @return returns map with new values
      */
     @SuppressWarnings("Duplicates")

aemdesign-aem-services/src/main/java/design/aem/models/v2/details/EventDetails.java

@@ -140,8 +140,8 @@ protected void ready() {
     /***
      * substitute formatted field template with fields from component.
      * @param componentProperties source map with fields
-     * @param i18n
-     * @param sling
+     * @param i18n i18n instance
+     * @param sling sling instance
      * @return returns map with new values
      */
     @SuppressWarnings("Duplicates")

aemdesign-aem-services/src/main/java/design/aem/models/v2/lists/List.java

@@ -420,7 +420,7 @@ static Map<String,Object> getPageBadgeInfo(Page page,String[] detailsNameSuffix,
 
     /**
      * get list options type.
-     * @return
+     * @return selected list type
      */
     protected Source getListType() {
         String listFromValue = componentProperties.get(PN_SOURCE, getCurrentStyle().get(PN_SOURCE, StringUtils.EMPTY));
@@ -429,7 +429,7 @@ protected Source getListType() {
 
     /**
      * get list items, used by HTL templates.
-     * @return
+     * @return collection of list types
      */
     public Collection<Map<String,Object>> getListItems() {
 
@@ -665,8 +665,8 @@ private void populateSearchListItems() {
 
     /**
      * get predicate group from query string.
-     * @param request
-     * @return
+     * @param request reques instance
+     * @return predicates converted from query string
      */
     public static PredicateGroup getPredicateGroupFromRequest(SlingHttpServletRequest request) {
 
@@ -691,7 +691,7 @@ public static PredicateGroup getPredicateGroupFromRequest(SlingHttpServletReques
     /**
      * get predicate group config from querystring param.
      * @param queryParam query string param, same as querybuilder
-     * @return
+     * @return predicates converted from query string
      */
     public static PredicateGroup getPredicateGroupFromQuery(String queryParam) {
 

aemdesign-aem-services/src/main/java/design/aem/models/v2/lists/SearchList.java

@@ -261,6 +261,7 @@ protected void ready() {
      *
      * @param slingRequest     `SlingHttpServletRequest` instance
      * @param resourceResolver `ResourceResolver` instance
+     * @return formed query object
      */
     public Query composeQueryBuilder(
             SlingHttpServletRequest slingRequest,
@@ -312,6 +313,7 @@ public Query composeQueryBuilder(
      * @param searchResults Array to store the normalised dataset in
      * @param sling         `SlingScriptHelper` instance
      * @param slingRequest  `SlingHttpServletRequest` instance
+     * @param result search result instance
      */
     public void normaliseContentTree(
             java.util.List<CustomSearchResult> searchResults,

aemdesign-aem-services/src/main/java/design/aem/utils/UserManagementUtil.java

@@ -162,8 +162,10 @@ public static String getEmail(Authorizable authorizable) throws RepositoryExcept
 
     /**
      * <p>Returns mailing target in format: "NAME" [E-MAIL].</p>
-     * @param authorizable user
+     * @param resourceResolver resolver instance
+     * @param authorizable user to check
      * @return Mailing target or null in case of non-specified email
+     * @throws RepositoryException if cant read content
      */
     public static String getNameAndEmail(ResourceResolver resourceResolver, Authorizable authorizable) throws RepositoryException {
         String email = getEmail(authorizable);

aemdesign-aem-services/src/main/java/design/aem/utils/components/CommonUtil.java

@@ -308,7 +308,6 @@ public static boolean validDetailComponent(String resourceType) {
      * @param page is the current page (for a reference to the root node)
      * @param nodeName  is the node name to check for
      * @return true if the script exists
-     * @throws RepositoryException when can't read content
      */
     public static boolean nodeExists(Page page, String nodeName) {
         if (page == null || isEmpty(nodeName)) {
@@ -432,7 +431,7 @@ public static String getSingularPropertyString(Node node, String key) throws Rep
     /***
      * find a component in a page root that matches required suffix.
      * @param inputPage is the page to look through for the component
-     * @param resourceTypeTail
+     * @param resourceTypeTail string to use for matching resource type
      * @return path to component
      */
     public static String findComponentInPage(Page inputPage, String[] resourceTypeTail) {
@@ -446,7 +445,6 @@ public static String findComponentInPage(Page inputPage, String[] resourceTypeTa
      * @param resourceTypeTail array for suffixes to check as endsWith with sling:resourceType or node name (as failover)
      * @param pageRoots        use matching page root as a staring point for search
      * @return the path to component
-     * @throws RepositoryException when can't read content
      */
     public static String findComponentInPage(Page inputPage, String[] resourceTypeTail, String[] pageRoots) {
 
@@ -549,6 +547,7 @@ public static long tryParseLong(String value, long defaultValue) {
      * Return a JCR node for a first found matching path
      *
      * @param thisPage is the page to inspect for newsdetails
+     * @param nodePaths paths to look for
      * @return a JCR node or null when not found
      */
     public static String getComponentNodePath(Page thisPage, String[] nodePaths) {
@@ -571,6 +570,7 @@ public static String getComponentNodePath(Page thisPage, String[] nodePaths) {
      * Return a JCR node for a first found matching path
      *
      * @param thisPage is the page to inspect for newsdetails
+     * @param nodePaths paths to look for
      * @return a JCR node or null when not found
      */
     public static Node getComponentNode(Page thisPage, String[] nodePaths) {
@@ -614,20 +614,24 @@ public static Node getComponentNode(Page thisPage, String componentPath) {
      * @param thisPage is the page to inspect for component
      * @return a JCR node or null when not found
      */
-    public static Node getFirstMediaNode(Page thisPage) throws RepositoryException {
+    public static Node getFirstMediaNode(Page thisPage) {
         Node media = null;
-        Node par = getComponentNode(thisPage, "article/par");
-        if (par != null) {
-            NodeIterator ite = par.getNodes();
-            while (ite.hasNext()) {
-                Node node = (Node) ite.next();
-                String type = node.getProperty(RESOURCE_TYPE).getValue().toString();
-                if ((type.indexOf("mediagallery") != -1) || (type.indexOf("video") != -1)) {
-                    media = node;
-                    break;
-                }
+        try {
+            Node par = getComponentNode(thisPage, "article/par");
+            if (par != null) {
+                NodeIterator ite = par.getNodes();
+                while (ite.hasNext()) {
+                    Node node = (Node) ite.next();
+                    String type = node.getProperty(RESOURCE_TYPE).getValue().toString();
+                    if ((type.indexOf("mediagallery") != -1) || (type.indexOf("video") != -1)) {
+                        media = node;
+                        break;
+                    }
 
+                }
             }
+        } catch (Exception ex) {
+            LOGGER.error("getFirstMediaNode: Could not get media node in page {}, err: {}",thisPage,ex);
         }
         return media;
 

aemdesign-aem-services/src/main/java/design/aem/utils/components/ComponentsUtil.java

@@ -601,8 +601,8 @@ public class ComponentsUtil {
      * Get a include file contents
      *
      * @param resourceResolver is the resource
-     * @param paths
-     * @param separator
+     * @param paths paths to check
+     * @param separator separator to use
      * @return a string with the file contents
      */
     public static String getResourceContent(ResourceResolver resourceResolver, String[] paths, String separator) {
@@ -1356,6 +1356,7 @@ public static ComponentProperties getComponentProperties(Map<String, Object> pag
      * return variant template name from component or return default
      * @param component component to check for variant template
      * @param variantTemplate variant template
+     * @param sling sling instance
      * @return variant template path
      */
     public static String getComponentVariantTemplate(Component component, String variantTemplate, SlingScriptHelper sling) {
@@ -1382,7 +1383,6 @@ public static String getComponentVariantTemplate(Component component, String var
      * @param data map of data attributes and values
      * @param xssAPI old xssi api
      * @return attributes string
-     * @throws IOException
      */
     @SuppressWarnings("Depreciated")
     public static String buildAttributesString(Map<String, String> data, com.adobe.granite.xss.XSSAPI xssAPI) {
@@ -1395,7 +1395,6 @@ public static String buildAttributesString(Map<String, String> data, com.adobe.g
      * @param xssAPI old xssi api
      * @param encodings map of encoding per data attribute
      * @return attributes string
-     * @throws IOException
      */
     @SuppressWarnings({"Depreciated", "squid:S3776"})
     public static String buildAttributesString(Map<String, String> data, com.adobe.granite.xss.XSSAPI xssAPI, Map<String, String> encodings) {
@@ -1446,7 +1445,7 @@ public static String buildAttributesString(Map<String, String> data, com.adobe.g
 
     /***
      *
-     * @deprecated please use responsive {@link design.aem.utils.components.ImagesUtil.getBackgroundImageRenditions} or ComponentProperties.attr which is an AttributeBuilder.
+     * @deprecated please use responsive {@link design.aem.utils.components.ImagesUtil#getBackgroundImageRenditions} or ComponentProperties.attr which is an AttributeBuilder.
      * add style tag to component attributes collection
      * @param componentProperties component attributes collection
      * @param resource resource to search for image
@@ -1724,6 +1723,7 @@ public static Resource findInheritedResource(Page page, ComponentContext compone
     /***
      * get attribute from first item list of maps.
      * @param sourceMap map to use
+     * @param attributeName attribute name
      * @return value of attribute from first found element
      */
     public static String getFirstAttributeFromList(LinkedHashMap<String, Map> sourceMap, String attributeName) {
@@ -1765,6 +1765,7 @@ public static String getComponentInPagePath(Node componentNode) {
      * find local resource in component and its super components
      * @param component component to check
      * @param resourceName local resource name
+     * @param sling sing instance
      * @return local resource path found
      */
     @SuppressWarnings("squid:S3776")
@@ -1831,10 +1832,10 @@ public static String findLocalResourceInSuperComponent(Component component, Stri
 
     /**
      * create a map of component fields matched to Dialog Title and Description
-     * @param componentResource
-     * @param adminResourceResolver
-     * @param slingScriptHelper
-     * @return
+     * @param componentResource component resource
+     * @param adminResourceResolver admin resolver
+     * @param slingScriptHelper sling script helper
+     * @return map of component dialog fields and their attributes
      */
     public static Map<String, Object> getComponentFieldsAndDialogMap(Resource componentResource , ResourceResolver adminResourceResolver, SlingScriptHelper slingScriptHelper) {
         Map<String, Object> firstComponentConfig = new HashMap<>();
@@ -2004,7 +2005,6 @@ public static boolean isStringRegex(String value, String patternToUse) {
      * @param value value to add into JXTL context
      * @return returns evaluated value
      * @throws JexlException throes Jexl errors with regex expression
-     * @throws Exception thows other errors
      *
      */
     public static Object evaluateExpressionWithValue(JxltEngine jxlt, JexlContext jc, String expression, Object value) {
@@ -2053,6 +2053,7 @@ public static String formattedRssDate(Calendar cal) {
      * Transform calendar into a publication date.
      *
      * @param cal is the calendar to transform
+     * @param format format to use
      * @return is the formatted RSS date.
      */
     public static String formatDate(Calendar cal, String format) {

aemdesign-aem-services/src/main/java/design/aem/utils/components/ImagesUtil.java

@@ -160,6 +160,7 @@ public class ImagesUtil {
      *
      * @param assetNode is the asset to interogate
      * @param key       is the key to get the metadata for
+     * @param defaultValue default value to return on null
      * @return the value or null when nothing is found
      */
     public static String getMetadataStringForKey(Node assetNode, String key, String defaultValue) {
@@ -281,16 +282,23 @@ public static Rendition getThumbnail(Asset asset, int minWidth) {
         return null;
     }
 
-    public static String getThumbnailUrl(Page page, ResourceResolver _resourceResolver) {
-        return _resourceResolver.map(page.getPath().concat(DEFAULT_THUMB_SELECTOR_MD));
+    /**
+     * get thumbnail url for a page.
+     * @param page page object
+     * @param resourceResolver resource resolver instance
+     * @return page thumbnail url
+     */
+    public static String getThumbnailUrl(Page page, ResourceResolver resourceResolver) {
+        return resourceResolver.map(page.getPath().concat(DEFAULT_THUMB_SELECTOR_MD));
     }
 
 
     /**
      * Get width of the asset
      *
+     * @param assetNode asset node to check metadata in
      * @return width of asset
-     * @throws javax.jcr.RepositoryException
+     * @throws javax.jcr.RepositoryException when can't access asset
      */
     public static int getWidth(Node assetNode) throws RepositoryException {
         int width = 0;
@@ -379,7 +387,6 @@ public static String getResourceImageCustomHref(Resource resource, String imageR
      * get asset reference for image node from a page
      * @param page to use as source
      * @return path to image or return default reference to page thumbnail selector
-     * @throws RepositoryException when can't read content
      */
     public static String getPageImgReferencePath(Page page) {
         String imagePath = getResourceImagePath(page.getContentResource(), DEFAULT_IMAGE_NODE_NAME);
@@ -934,6 +941,9 @@ public static ComponentProperties getBackgroundImageRenditions(Map<String, Objec
     /***
      * get resource image settings.
      * @param wcmUsePojoModel component model model
+     * @param resource resource to use
+     * @param attributeName attribute name to use
+     * @param returnLastRenditionName  rendition to stop search on
      * @return returns map of attributes
      */
     public static ComponentProperties getResourceImageRenditions(WCMUsePojo wcmUsePojoModel, Resource resource, String attributeName, String returnLastRenditionName) {
@@ -953,6 +963,9 @@ public static ComponentProperties getResourceImageRenditions(WCMUsePojo wcmUsePo
     /***
      * get resource image settings.
      * @param pageContext page context
+     * @param resource resource to use
+     * @param attributeName attribute name to use
+     * @param returnLastRenditionName last rendition to return if not found
      * @return returns map of attributes
      */
     public static ComponentProperties getResourceImageRenditions(PageContext pageContext, Resource resource, String attributeName, String returnLastRenditionName) {
@@ -971,6 +984,9 @@ public static ComponentProperties getResourceImageRenditions(PageContext pageCon
     /***
      * get resource image settings.
      * @param pageContext page context map
+     * @param imageResource resource to use
+     * @param returnRenditionsListName  name of the attribute to create for rendition list
+     * @param returnLastRenditionName last rendition to return if not found
      * @return returns map of attributes
      */
     @SuppressWarnings("Duplicates")
@@ -1148,14 +1164,14 @@ public static Map<String, String> getBestFitMediaQueryRenditionSet(com.adobe.gra
     /**
      * function to filter out the design dialog values which are not matching adaptive profile
      *
-     * @param adaptiveImageMapping
-     * @param resolver
+     * @param adaptiveImageMapping image mapping config
+     * @param resolver resolver instance
      * @param componentPath                path to component doing the render
      * @param fileReference                path to asset to use for render
      * @param outputFormat                 specify which output format to use
      * @param useFileReferencePathAsRender create paths using fileReference instead of using Component Path
-     * @param sling
-     * @return Map<Integer   ,       String>
+     * @param sling sling instance
+     * @return map of urls
      */
     public static Map<String, String> getAdaptiveImageSet(String[] adaptiveImageMapping, ResourceResolver resolver, String componentPath, String fileReference, String outputFormat, Boolean useFileReferencePathAsRender, org.apache.sling.api.scripting.SlingScriptHelper sling) {
 
@@ -1222,8 +1238,8 @@ public static Map<String, String> getAdaptiveImageSet(String[] adaptiveImageMapp
     /**
      * return list of configured widths in com.day.cq.wcm.foundation.impl.AdaptiveImageComponentServlet
      *
-     * @param sling
-     * @return int []
+     * @param sling sling instance
+     * @return list of ints allowed
      */
     @SuppressWarnings("unchecked")
     public static int[] getAdaptiveImageSupportedWidths(org.apache.sling.api.scripting.SlingScriptHelper sling) {