This is an automated email from the ASF dual-hosted git repository. jsedding pushed a commit to branch resolver-2.x-backports in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-resolver.git
commit 8a7689cdba255fae5a3df4101dd05bddf763d287 Author: Jörg Hoh <[email protected]> AuthorDate: Mon Jul 27 14:12:38 2026 +0200 SLING-13272 fix javadoc warnings (#72) (cherry picked from commit d3ba2d8b627f6640931ab46364df4ba6d23bedc9) --- .../api/IgnoredServletResourcePredicate.java | 6 +++--- .../helper/NamedScriptResourceCollector.java | 2 +- .../resolver/internal/helper/ResourceCollector.java | 21 +++++++-------------- .../resolver/internal/helper/WeightedResource.java | 2 +- 4 files changed, 12 insertions(+), 19 deletions(-) diff --git a/src/main/java/org/apache/sling/servlets/resolver/api/IgnoredServletResourcePredicate.java b/src/main/java/org/apache/sling/servlets/resolver/api/IgnoredServletResourcePredicate.java index 2aa8667..b3a99bb 100644 --- a/src/main/java/org/apache/sling/servlets/resolver/api/IgnoredServletResourcePredicate.java +++ b/src/main/java/org/apache/sling/servlets/resolver/api/IgnoredServletResourcePredicate.java @@ -27,9 +27,9 @@ import org.osgi.annotation.versioning.ConsumerType; * to hide specific scripts or servlets from the resolution * mechanism. Can be used for "soft deprecation" of scripts and * servlets for example. - * - * @returns true if the supplied Resource must be ignored by - * the servlets resolver. + * <p> + * The predicate returns {@code true} if the supplied Resource must be + * ignored by the servlets resolver. */ @ConsumerType public interface IgnoredServletResourcePredicate extends Predicate<Resource> {} diff --git a/src/main/java/org/apache/sling/servlets/resolver/internal/helper/NamedScriptResourceCollector.java b/src/main/java/org/apache/sling/servlets/resolver/internal/helper/NamedScriptResourceCollector.java index 3ea1385..1a1eeb6 100644 --- a/src/main/java/org/apache/sling/servlets/resolver/internal/helper/NamedScriptResourceCollector.java +++ b/src/main/java/org/apache/sling/servlets/resolver/internal/helper/NamedScriptResourceCollector.java @@ -29,7 +29,7 @@ import org.apache.sling.servlets.resolver.internal.SlingServletResolver; /** * The <code>ResourceCollector</code> class provides a single public method - - * {@link #getServlets(ResourceResolver)} - which is used to find an ordered collection + * {@link #getServlets(ResourceResolver, List)} - which is used to find an ordered collection * of <code>Resource</code> instances which may be used to find a servlet or * script to handle a request to the given resource. */ diff --git a/src/main/java/org/apache/sling/servlets/resolver/internal/helper/ResourceCollector.java b/src/main/java/org/apache/sling/servlets/resolver/internal/helper/ResourceCollector.java index c74b007..0543830 100644 --- a/src/main/java/org/apache/sling/servlets/resolver/internal/helper/ResourceCollector.java +++ b/src/main/java/org/apache/sling/servlets/resolver/internal/helper/ResourceCollector.java @@ -33,18 +33,16 @@ import org.apache.sling.servlets.resolver.internal.resource.ServletResourceProvi /** * The <code>ResourceCollector</code> class provides a single public method - - * {@link #getServlets(ResourceResolver)} - which is used to find an ordered + * {@link #getServlets(ResourceResolver, List)} - which is used to find an ordered * collection of <code>Resource</code> instances which may be used to find a * servlet or script to handle a request to the given resource. */ public class ResourceCollector extends AbstractResourceCollector { /** - * The special value returned by - * {@link #calculatePrefixMethodWeight(Resource, String, boolean)} if the - * resource is not suitable to handle the request according to the location - * prefix, request selectors and request extension (value is - * <code>Integer.MIN_VALUE</code>). + * The special value indicating that the resource is not suitable to handle + * the request according to the location prefix, request selectors and + * request extension (value is <code>Integer.MIN_VALUE</code>). */ protected static final int WEIGHT_NO_MATCH = Integer.MIN_VALUE; @@ -123,12 +121,12 @@ public class ResourceCollector extends AbstractResourceCollector { * @param baseResourceType The basic resource type to use as a final * resource super type. If this is <code>null</code> the default * value - * {@link org.apache.sling.servlets.resolver.internal.ServletResolverConstants#DEFAULT_SERVLET_NAME} + * {@link ServletResolverConstants#DEFAULT_RESOURCE_TYPE} * is assumed. * @param resource the resource to invoke, the resource type and resource * super type are taken from this resource. * @param executionPaths the execution paths to consider - * @deprecated use {@link #ResourceCollector(String, String, Resource, String, String[])} instead. + * @deprecated use {@link #ResourceCollector(String, String, Resource, String, String[], boolean)} instead. */ @Deprecated public ResourceCollector( @@ -148,7 +146,7 @@ public class ResourceCollector extends AbstractResourceCollector { * @param baseResourceType The basic resource type to use as a final * resource super type. If this is <code>null</code> the default * value - * {@link org.apache.sling.servlets.resolver.internal.ServletResolverConstants#DEFAULT_SERVLET_NAME} + * {@link ServletResolverConstants#DEFAULT_RESOURCE_TYPE} * is assumed. * @param resource the resource to invoke, the resource type and resource * super type are taken from this resource. @@ -193,11 +191,6 @@ public class ResourceCollector extends AbstractResourceCollector { * * @param methodName The <code>methodName</code> used to find scripts for. * This must not be <code>null</code>. - * @param baseResourceType The basic resource type to use as a final - * resource super type. If this is <code>null</code> the default - * value - * {@link org.apache.sling.servlets.resolver.internal.ServletResolverConstants#DEFAULT_SERVLET_NAME} - * is assumed. */ private ResourceCollector( final Resource resource, diff --git a/src/main/java/org/apache/sling/servlets/resolver/internal/helper/WeightedResource.java b/src/main/java/org/apache/sling/servlets/resolver/internal/helper/WeightedResource.java index 332f212..c6b0220 100644 --- a/src/main/java/org/apache/sling/servlets/resolver/internal/helper/WeightedResource.java +++ b/src/main/java/org/apache/sling/servlets/resolver/internal/helper/WeightedResource.java @@ -25,7 +25,7 @@ import org.apache.sling.api.resource.ResourceWrapper; * The <code>WeightedResource</code> is a <code>Resource</code> which is * attributed with weight values to make it a <code>Comparable</code> to be * used to build the result collection returned by - * {@link ResourceCollector#getServlets(Resource)}. + * {@link AbstractResourceCollector#getServlets(org.apache.sling.api.resource.ResourceResolver, java.util.List)}. * <p> * The order amongst <code>WeightedResource</code> instances is defined as * follows and implemented in the {@link #compareTo(WeightedResource)} method:
