SLING-11580 fix javadocs
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 @@
* 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 @@
/**
* 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 @@
/**
* 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 @@
/**
* 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 @@
* 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 @@
/**
* 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 @@
/**
* 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 @@
* 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 @@
* 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 @@
* 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.
