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 2021/10/27 15:23:11 UTC
[sling-org-apache-sling-api] 01/01: SLING-10871 add since tags
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch feature/SLING-10871-improve-javadoc
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-api.git
commit f95ab5f336a41fbd710fb121e5f1cda871bfed3f
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Wed Oct 27 17:22:53 2021 +0200
SLING-10871 add since tags
improve javadoc
---
.../java/org/apache/sling/api/request/builder/Builders.java | 5 +++++
.../api/request/builder/SlingHttpServletRequestBuilder.java | 11 ++++++-----
.../api/request/builder/SlingHttpServletResponseBuilder.java | 1 +
.../api/request/builder/SlingHttpServletResponseResult.java | 1 +
4 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/sling/api/request/builder/Builders.java b/src/main/java/org/apache/sling/api/request/builder/Builders.java
index 542ad29..8ea37a6 100644
--- a/src/main/java/org/apache/sling/api/request/builder/Builders.java
+++ b/src/main/java/org/apache/sling/api/request/builder/Builders.java
@@ -23,6 +23,11 @@ import org.apache.sling.api.request.builder.impl.SlingHttpServletResponseImpl;
import org.apache.sling.api.resource.Resource;
import org.jetbrains.annotations.NotNull;
+/**
+ * Creates builders.
+ * @since 1.0. (Sling API Bundle 2.24.0)
+ *
+ */
public final class Builders {
private Builders() {}
diff --git a/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletRequestBuilder.java b/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletRequestBuilder.java
index 7181985..fc7a884 100644
--- a/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletRequestBuilder.java
+++ b/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletRequestBuilder.java
@@ -31,6 +31,7 @@ import org.osgi.annotation.versioning.ProviderType;
* Fluent helper for building a request.
*
* Instances of this interface are not thread-safe.
+ * @since 1.0. (Sling API Bundle 2.24.0)
*/
@ProviderType
public interface SlingHttpServletRequestBuilder {
@@ -58,14 +59,14 @@ public interface SlingHttpServletRequestBuilder {
@NotNull SlingHttpServletRequestBuilder withBody(@Nullable String content);
/**
- * Sets the optional selectors of the internal request, which influence the Servlet/Script resolution.
+ * Sets the optional selectors of the internal request, which influence the servlet/script resolution.
* @param selectors the selectors
* @return this object
*/
@NotNull SlingHttpServletRequestBuilder withSelectors(@Nullable String ... selectors);
/**
- * Sets the optional extension of the internal request, which influences the Servlet/Script resolution.
+ * Sets the optional extension of the internal request, which influences the servlet/script resolution.
* @param extension the extension
* @return this object
*/
@@ -79,7 +80,7 @@ public interface SlingHttpServletRequestBuilder {
@NotNull SlingHttpServletRequestBuilder withSuffix(@Nullable String suffix);
/**
- * Sets a request parameter
+ * Sets a request parameter.
* @param key the name of the parameter
* @param value the value of the parameter
* @return this object
@@ -88,7 +89,7 @@ public interface SlingHttpServletRequestBuilder {
@NotNull SlingHttpServletRequestBuilder withParameter(@NotNull String key, @NotNull String value);
/**
- * Sets a request parameter
+ * Sets a request parameter.
* @param key the name of the parameter
* @param values the values of the parameter
* @return this object
@@ -128,7 +129,7 @@ public interface SlingHttpServletRequestBuilder {
@NotNull SlingHttpServletRequestBuilder useAttributesFrom(@NotNull HttpServletRequest request);
/**
- * Uses the servlet context from the provided request
+ * Uses the servlet context from the provided request.
* @param request the request from which to use the servlet context
* @return this object
* @throws IllegalArgumentException if {@code request} is {@code null}
diff --git a/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseBuilder.java b/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseBuilder.java
index 71b7fb6..5a1748a 100644
--- a/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseBuilder.java
+++ b/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseBuilder.java
@@ -24,6 +24,7 @@ import org.osgi.annotation.versioning.ProviderType;
/**
* <p>Fluent helper for building a response.</p>
* <p><strong>Note:</strong> instances of this interface are not thread-safe.</p>
+ * @since 1.0. (Sling API Bundle 2.24.0)
*/
@ProviderType
public interface SlingHttpServletResponseBuilder {
diff --git a/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseResult.java b/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseResult.java
index 081d2e5..6d41cfc 100644
--- a/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseResult.java
+++ b/src/main/java/org/apache/sling/api/request/builder/SlingHttpServletResponseResult.java
@@ -29,6 +29,7 @@ import org.osgi.annotation.versioning.ProviderType;
* <p>This is an extension of a {@link SlingHttpServletResponse} to get the result from a processing operation.</p>
*
* <p><strong>Note:</strong> instances of this interface are not thread-safe.</p>
+ * @since 1.0. (Sling API Bundle 2.24.0)
*/
@ProviderType
public interface SlingHttpServletResponseResult extends SlingHttpServletResponse {