You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by jo...@apache.org on 2022/09/13 14:46:47 UTC
[sling-org-apache-sling-rewriter] branch SLING-11580-fix-javadoc created (now 68f1bea)
This is an automated email from the ASF dual-hosted git repository.
joerghoh pushed a change to branch SLING-11580-fix-javadoc
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-rewriter.git
at 68f1bea SLING-11580 fix javadocs
This branch includes the following new commits:
new 68f1bea SLING-11580 fix javadocs
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[sling-org-apache-sling-rewriter] 01/01: SLING-11580 fix javadocs
Posted by jo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
joerghoh pushed a commit to branch SLING-11580-fix-javadoc
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-rewriter.git
commit 68f1bead98366ee73ae8176f687be99d9dcd1198
Author: Joerg Hoh <jo...@apache.org>
AuthorDate: Tue Sep 13 16:45:56 2022 +0200
SLING-11580 fix javadocs
---
src/main/java/org/apache/sling/rewriter/Generator.java | 3 +++
src/main/java/org/apache/sling/rewriter/PipelineConfiguration.java | 3 +++
src/main/java/org/apache/sling/rewriter/ProcessingContext.java | 7 +++++++
src/main/java/org/apache/sling/rewriter/Processor.java | 1 +
.../java/org/apache/sling/rewriter/ProcessorConfiguration.java | 1 +
src/main/java/org/apache/sling/rewriter/ProcessorManager.java | 4 ++++
src/main/java/org/apache/sling/rewriter/Serializer.java | 1 +
src/main/java/org/apache/sling/rewriter/Transformer.java | 1 +
.../rewriter/impl/components/AbstractTraxSerializerFactory.java | 2 ++
9 files changed, 23 insertions(+)
diff --git a/src/main/java/org/apache/sling/rewriter/Generator.java b/src/main/java/org/apache/sling/rewriter/Generator.java
index 7424206..374e44e 100644
--- a/src/main/java/org/apache/sling/rewriter/Generator.java
+++ b/src/main/java/org/apache/sling/rewriter/Generator.java
@@ -34,6 +34,7 @@ public interface Generator {
* Initialize this component.
* @param context The invocation context.
* @param config The configuration for this component.
+ * @throws IOException in case of any problems
*/
void init(ProcessingContext context, ProcessingComponentConfiguration config)
throws IOException;
@@ -53,6 +54,8 @@ public interface Generator {
/**
* Notify the generator that parsing is finished.
+ * @throws IOException IOException
+ * @throws SAXException SAXException
*/
void finished() throws IOException, SAXException;
diff --git a/src/main/java/org/apache/sling/rewriter/PipelineConfiguration.java b/src/main/java/org/apache/sling/rewriter/PipelineConfiguration.java
index 958d1a0..1cd232a 100644
--- a/src/main/java/org/apache/sling/rewriter/PipelineConfiguration.java
+++ b/src/main/java/org/apache/sling/rewriter/PipelineConfiguration.java
@@ -24,16 +24,19 @@ public interface PipelineConfiguration extends ProcessorConfiguration {
/**
* The configuration for the generator.
+ * @return the configuration for the generator
*/
ProcessingComponentConfiguration getGeneratorConfiguration();
/**
* The configuration for the serializer.
+ * @return the configuration for the serializer
*/
ProcessingComponentConfiguration getSerializerConfiguration();
/**
* The configuration for the transformers.
+ * @return the configuration for the transformers
*/
ProcessingComponentConfiguration[] getTransformerConfigurations();
}
diff --git a/src/main/java/org/apache/sling/rewriter/ProcessingContext.java b/src/main/java/org/apache/sling/rewriter/ProcessingContext.java
index 5fe0caa..4fdd8a1 100644
--- a/src/main/java/org/apache/sling/rewriter/ProcessingContext.java
+++ b/src/main/java/org/apache/sling/rewriter/ProcessingContext.java
@@ -30,26 +30,33 @@ public interface ProcessingContext {
/**
* The current request.
+ * @return the current request
*/
SlingHttpServletRequest getRequest();
/**
* The current response.
+ * @return the current response
*/
SlingHttpServletResponse getResponse();
/**
* The content type of the response.
+ * @return the content type
*/
String getContentType();
/**
* The writer.
+ * @return the writer
+ * @throws IOException in case of problems
*/
PrintWriter getWriter() throws IOException;
/**
* The output stream.
+ * @return the outputStream
+ * @throws IOException in case of problems
*/
OutputStream getOutputStream() throws IOException;
}
diff --git a/src/main/java/org/apache/sling/rewriter/Processor.java b/src/main/java/org/apache/sling/rewriter/Processor.java
index 860bb03..96d1a4e 100644
--- a/src/main/java/org/apache/sling/rewriter/Processor.java
+++ b/src/main/java/org/apache/sling/rewriter/Processor.java
@@ -52,6 +52,7 @@ public interface Processor {
* Clean up the processor.
* This method should always be called after a processor run, regardless if it was successful or failed.
* @param errorOccurred Indicates if an error occurred during processing
+ * @throws IOException in case of problems
*/
void finished(boolean errorOccurred) throws IOException;
}
diff --git a/src/main/java/org/apache/sling/rewriter/ProcessorConfiguration.java b/src/main/java/org/apache/sling/rewriter/ProcessorConfiguration.java
index 52d1659..6774811 100644
--- a/src/main/java/org/apache/sling/rewriter/ProcessorConfiguration.java
+++ b/src/main/java/org/apache/sling/rewriter/ProcessorConfiguration.java
@@ -38,6 +38,7 @@ public interface ProcessorConfiguration {
/**
* Check if this processor configuration matches for the current request.
+ * @param context the processing context
* @return true or false
*/
boolean match(ProcessingContext context);
diff --git a/src/main/java/org/apache/sling/rewriter/ProcessorManager.java b/src/main/java/org/apache/sling/rewriter/ProcessorManager.java
index d9ae174..b3c1e76 100644
--- a/src/main/java/org/apache/sling/rewriter/ProcessorManager.java
+++ b/src/main/java/org/apache/sling/rewriter/ProcessorManager.java
@@ -31,6 +31,10 @@ public interface ProcessorManager {
/**
* Return a pipeline for a pipeline configuration.
+ * param configuration the configuration for the processor
+ * @param context the processing context
+ * @param configuration the configuration for the processor
+ * @return the processor
* @throws org.apache.sling.api.SlingException If an error occurs during setup
*/
Processor getProcessor(ProcessorConfiguration configuration,
diff --git a/src/main/java/org/apache/sling/rewriter/Serializer.java b/src/main/java/org/apache/sling/rewriter/Serializer.java
index 235d2be..bc2a7e3 100644
--- a/src/main/java/org/apache/sling/rewriter/Serializer.java
+++ b/src/main/java/org/apache/sling/rewriter/Serializer.java
@@ -29,6 +29,7 @@ public interface Serializer extends ContentHandler {
* Initialize this component.
* @param context The invocation context.
* @param config The configuration for this component.
+ * @throws IOException in case of problems
*/
void init(ProcessingContext context, ProcessingComponentConfiguration config)
throws IOException;
diff --git a/src/main/java/org/apache/sling/rewriter/Transformer.java b/src/main/java/org/apache/sling/rewriter/Transformer.java
index 4daca4f..f67eff5 100644
--- a/src/main/java/org/apache/sling/rewriter/Transformer.java
+++ b/src/main/java/org/apache/sling/rewriter/Transformer.java
@@ -29,6 +29,7 @@ public interface Transformer extends ContentHandler {
* Initialize this component.
* @param context The invocation context.
* @param config The configuration for this component.
+ * @throws IOException in case of any problems
*/
void init(ProcessingContext context, ProcessingComponentConfiguration config)
throws IOException;
diff --git a/src/main/java/org/apache/sling/rewriter/impl/components/AbstractTraxSerializerFactory.java b/src/main/java/org/apache/sling/rewriter/impl/components/AbstractTraxSerializerFactory.java
index a4fa0cc..6aaa7cf 100644
--- a/src/main/java/org/apache/sling/rewriter/impl/components/AbstractTraxSerializerFactory.java
+++ b/src/main/java/org/apache/sling/rewriter/impl/components/AbstractTraxSerializerFactory.java
@@ -101,6 +101,8 @@ public abstract class AbstractTraxSerializerFactory implements SerializerFactory
* The check consists in sending SAX events representing a minimal namespaced document
* with namespaces defined only with calls to <code>startPrefixMapping</code> (no
* xmlns:xxx attributes) and check if they are present in the resulting text.
+ * @return if the support is given
+ * @throws Exception in case of any exception during the check
*/
protected boolean needsNamespacesAsAttributes() throws Exception {
// Serialize a minimal document to check how namespaces are handled.