You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by kw...@apache.org on 2018/06/14 15:55:59 UTC
[sling-org-apache-sling-servlets-annotations] branch master
updated: fix javadoc warnings in java8
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-annotations.git
The following commit(s) were added to refs/heads/master by this push:
new c078f0d fix javadoc warnings in java8
c078f0d is described below
commit c078f0d8fb28583abe89d44eaf12cb0cea293736
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Thu Jun 14 17:55:34 2018 +0200
fix javadoc warnings in java8
---
.../org/apache/sling/servlets/annotations/SlingServletFilter.java | 4 +++-
.../apache/sling/servlets/annotations/SlingServletFilterScope.java | 2 +-
.../java/org/apache/sling/servlets/annotations/SlingServletName.java | 1 +
.../org/apache/sling/servlets/annotations/SlingServletPaths.java | 2 +-
.../org/apache/sling/servlets/annotations/SlingServletPrefix.java | 1 +
.../apache/sling/servlets/annotations/SlingServletResourceTypes.java | 5 ++++-
6 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilter.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilter.java
index bb961d9..326a5ee 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilter.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilter.java
@@ -50,12 +50,14 @@ public @interface SlingServletFilter {
/**
* Restrict the filter to paths that match the supplied regular expression. Requires Sling Engine 2.4.0.
+ * @return the pattern to restrict the filter
*/
String pattern() default "";
/**
- * The scopes of a filter. If the filter has request scope, it is run once for a request. If the filter has component scope, it is run
+ * The scopes of the filter. If the filter has request scope, it is run once for a request. If the filter has component scope, it is run
* once for every included component (rendering).
+ * @return the scope of the filter
*/
SlingServletFilterScope[] scope() default SlingServletFilterScope.REQUEST;
}
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilterScope.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilterScope.java
index ac92f02..6778346 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilterScope.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletFilterScope.java
@@ -43,7 +43,7 @@ public enum SlingServletFilterScope {
/**
* Filters are called upon {@link HttpServletResponse#sendError(int)} or {@link HttpServletResponse#sendError(int, String)}
* or any uncaught Throwable before resolving the error handler Servlet or script.
- * <p>Servlet API Correspondence: {@code ERROR}</
+ * <p>Servlet API Correspondence: {@code ERROR}</p>
*/
ERROR("ERROR"),
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletName.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletName.java
index f10ce34..30d62dd 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletName.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletName.java
@@ -39,6 +39,7 @@ public @interface SlingServletName {
* <code>component.name</code> property or the <code>service.pid</code>
* is used. If none of the three properties is defined, the Servlet is
* ignored.
+ * @return the servlet name
* @see ServletResolverConstants#SLING_SERVLET_NAME
*/
String servletName();
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java
index ab8c624..5e25134 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPaths.java
@@ -43,7 +43,7 @@ public @interface SlingServletPaths {
* A servlet using this property might be ignored unless its path is included
* in the Execution Paths {@code servletresolver.paths} configuration setting of the
* {@code org.apache.sling.servlets.resolver.internal.SlingServletResolver} service.
- *
+ * @return the absolute paths under which the servlet is accessible as a resource
* @see ServletResolverConstants#SLING_SERVLET_PATHS
*/
String[] value();
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java
index 7f3aab6..2213e9c 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletPrefix.java
@@ -47,6 +47,7 @@ public @interface SlingServletPrefix {
* If this property is empty, the configuration of the {@code org.apache.sling.servlets.resolver.internal.SlingServletResolver}
* service is used.
* In case even that one is not set "/" is used as prefix.
+ * @return the prefix
* @see ServletResolverConstants#SLING_SERVLET_PREFIX
*/
String value();
diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletResourceTypes.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletResourceTypes.java
index 5fef52f..f779507 100644
--- a/src/main/java/org/apache/sling/servlets/annotations/SlingServletResourceTypes.java
+++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletResourceTypes.java
@@ -40,7 +40,7 @@ public @interface SlingServletResourceTypes {
* is "sling.servlet.resourceTypes").
* A relative resource type is made absolute by prefixing it with the value set through the
* {@link SlingServletPrefix} annotation.
- * <p>
+ * @return the resource type(s)
*/
String[] resourceTypes();
@@ -50,6 +50,7 @@ public @interface SlingServletResourceTypes {
* is as a list of dot-separated strings such as <em>print.a4</em>.
* In case this is not empty the first selector(s) (i.e. the most right-hand ones in the URL) must match,
* otherwise the servlet is not executed. After that may follow arbitrarily many non-registered selectors.
+ * @return the selector(s)
* @see ServletResolverConstants#SLING_SERVLET_SELECTORS
*/
String[] selectors() default {};
@@ -59,6 +60,7 @@ public @interface SlingServletResourceTypes {
* for GET requests.
* <p>
* It this is not set, the servlet is not limited to certain extensions.
+ * @return the extension(s)
* @see ServletResolverConstants#SLING_SERVLET_EXTENSIONS
*/
String[] extensions() default {};
@@ -68,6 +70,7 @@ public @interface SlingServletResourceTypes {
* methods or "*" for all methods.
* <p>
* If this is not set (i.e. empty array) it is assumed to be {@code GET} and {@code HEAD}.
+ * @return the methods(s)
* @see ServletResolverConstants#SLING_SERVLET_METHODS
* @see <a href="https://tools.ietf.org/html/rfc7231#section-4.3">HTTP 1.1 Spec Methods</a>
*/
--
To stop receiving notification emails like this one, please contact
kwin@apache.org.