[tomcat-jakartaee-migration] 02/07: Add Javadoc

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomcat-jakartaee-migration.git

commit d8373f2e132434e4e8b1aec9fed30f599e6d0eb8
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Feb 9 14:24:54 2021 +0000

    Add Javadoc
---
 src/main/java/org/apache/tomcat/jakartaee/Converter.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/main/java/org/apache/tomcat/jakartaee/Converter.java b/src/main/java/org/apache/tomcat/jakartaee/Converter.java
index 92ef1dd..5a62b5c 100644
--- a/src/main/java/org/apache/tomcat/jakartaee/Converter.java
+++ b/src/main/java/org/apache/tomcat/jakartaee/Converter.java
@@ -24,5 +24,15 @@ public interface Converter {
 
     boolean accepts(String filename);
 
+    /**
+     * Copies the source to the destination, converting it if necessary,
+     * according to the requirements of the given profile.
+     *
+     * @param src       The source data to convert
+     * @param dest      The destination to write the converted data
+     * @param profile   The profile that defines the conversion required
+     *
+     * @throws IOException  If the conversion fails
+     */
     void convert(InputStream src, OutputStream dest, EESpecProfile profile) throws IOException;
 }


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org