This is an automated email from the ASF dual-hosted git repository.
joerghoh pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-engine.git
The following commit(s) were added to refs/heads/master by this push:
new 973526a SLING-13377 Fix Javadoc (#103)
973526a is described below
commit 973526a9db42b0edd524bc1a6c8cbf282a83ab4d
Author: Bhavik Kothari <[email protected]>
AuthorDate: Thu Oct 8 19:11:52 2026 +0530
SLING-13377 Fix Javadoc (#103)
---
.../org/apache/sling/engine/EngineConstants.java | 10 ++++++++++
.../java/org/apache/sling/engine/RequestUtil.java | 9 +++++++++
.../java/org/apache/sling/engine/ResponseUtil.java | 9 +++++++++
.../org/apache/sling/engine/jmx/package-info.java | 3 +++
.../java/org/apache/sling/engine/package-info.java | 3 +++
.../servlets/AbstractServiceReferenceConfig.java | 20 ++++++++++++++++++++
.../apache/sling/engine/servlets/package-info.java | 3 +++
7 files changed, 57 insertions(+)
diff --git a/src/main/java/org/apache/sling/engine/EngineConstants.java
b/src/main/java/org/apache/sling/engine/EngineConstants.java
index 23fe0fc..d4c2854 100644
--- a/src/main/java/org/apache/sling/engine/EngineConstants.java
+++ b/src/main/java/org/apache/sling/engine/EngineConstants.java
@@ -26,6 +26,16 @@ package org.apache.sling.engine;
*/
public class EngineConstants {
+ /**
+ * Explicit public constructor for backward binary compatibility.
+ * @deprecated Instantiation not intended.
+ */
+ @Deprecated
+ @SuppressWarnings("java:S1118")
+ public EngineConstants() {
+ // Explicit constructor for backward binary compatibility
+ }
+
/**
* The name of the framework property defining the Sling home directory
* (value is "sling.home"). This is a Platform file system directory below
diff --git a/src/main/java/org/apache/sling/engine/RequestUtil.java
b/src/main/java/org/apache/sling/engine/RequestUtil.java
index ac01185..a600694 100644
--- a/src/main/java/org/apache/sling/engine/RequestUtil.java
+++ b/src/main/java/org/apache/sling/engine/RequestUtil.java
@@ -29,6 +29,15 @@ import java.util.Map;
@Deprecated
public class RequestUtil {
+ /**
+ * @deprecated Instantiation not intended. Use {@link
org.apache.sling.api.request.RequestUtil} instead.
+ */
+ @Deprecated
+ @SuppressWarnings("java:S1118")
+ public RequestUtil() {
+ // Explicit constructor for backward binary compatibility
+ }
+
/**
* Parses a header of the form:
*
diff --git a/src/main/java/org/apache/sling/engine/ResponseUtil.java
b/src/main/java/org/apache/sling/engine/ResponseUtil.java
index 90fcb2f..f108c62 100644
--- a/src/main/java/org/apache/sling/engine/ResponseUtil.java
+++ b/src/main/java/org/apache/sling/engine/ResponseUtil.java
@@ -27,6 +27,15 @@ import java.io.Writer;
@Deprecated
public class ResponseUtil {
+ /**
+ * @deprecated Instantiation not intended. Use {@link
org.apache.sling.api.request.ResponseUtil} instead.
+ */
+ @Deprecated
+ @SuppressWarnings("java:S1118")
+ public ResponseUtil() {
+ // Explicit constructor for backward binary compatibility
+ }
+
/**
* Escape xml text
* @param input The text to escape
diff --git a/src/main/java/org/apache/sling/engine/jmx/package-info.java
b/src/main/java/org/apache/sling/engine/jmx/package-info.java
index 3aa793c..5fb685b 100644
--- a/src/main/java/org/apache/sling/engine/jmx/package-info.java
+++ b/src/main/java/org/apache/sling/engine/jmx/package-info.java
@@ -17,5 +17,8 @@
* under the License.
*/
+/**
+ * Provides JMX MBeans for monitoring and management of the Sling Engine.
+ */
@org.osgi.annotation.versioning.Version("1.1.1")
package org.apache.sling.engine.jmx;
diff --git a/src/main/java/org/apache/sling/engine/package-info.java
b/src/main/java/org/apache/sling/engine/package-info.java
index b3a72a4..eaeb327 100644
--- a/src/main/java/org/apache/sling/engine/package-info.java
+++ b/src/main/java/org/apache/sling/engine/package-info.java
@@ -17,5 +17,8 @@
* under the License.
*/
+/**
+ * Provides the main framework and interfaces for the Sling Engine.
+ */
@org.osgi.annotation.versioning.Version("2.7.0")
package org.apache.sling.engine;
diff --git
a/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
b/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
index 905baa1..3269b92 100644
---
a/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
+++
b/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
@@ -89,16 +89,36 @@ public abstract class AbstractServiceReferenceConfig {
this.name = name;
}
+ /**
+ * Returns the value of the named initialization parameter, or {@code null}
+ * if the parameter does not exist.
+ *
+ * @param name The name of the initialization parameter.
+ * @return The value of the parameter or {@code null}.
+ */
public String getInitParameter(String name) {
Object prop = reference.getProperty(name);
return (prop == null) ? null : String.valueOf(prop);
}
+ /**
+ * Returns the property keys of the underlying OSGi {@link
ServiceReference} as an
+ * {@code Enumeration} of String objects, or an empty {@code Enumeration}
+ * if there are no properties.
+ *
+ * @return An {@code Enumeration} of parameter names.
+ */
public Enumeration<?> getInitParameterNames() {
List<?> keys = Arrays.asList(reference.getPropertyKeys());
return Collections.enumeration(keys);
}
+ /**
+ * Returns a reference to the {@link ServletContext} in which the caller
+ * is executing.
+ *
+ * @return The {@link ServletContext} object.
+ */
public ServletContext getServletContext() {
return servletContext;
}
diff --git a/src/main/java/org/apache/sling/engine/servlets/package-info.java
b/src/main/java/org/apache/sling/engine/servlets/package-info.java
index f617e0e..3d33165 100644
--- a/src/main/java/org/apache/sling/engine/servlets/package-info.java
+++ b/src/main/java/org/apache/sling/engine/servlets/package-info.java
@@ -17,5 +17,8 @@
* under the License.
*/
+/**
+ * Provides support and base classes for servlet and filter configuration
within the Sling Engine.
+ */
@org.osgi.annotation.versioning.Version("2.0.10")
package org.apache.sling.engine.servlets;
