[maven-jxr] branch JXR-145 updated: [JXR-145] Add missing interface

[rf...@apache.org]

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

rfscholte pushed a commit to branch JXR-145
in repository https://gitbox.apache.org/repos/asf/maven-jxr.git


The following commit(s) were added to refs/heads/JXR-145 by this push:
     new cc1e40f  [JXR-145] Add missing interface
cc1e40f is described below

commit cc1e40f8aed0bb7c55b625fd653aface1c2f42ea
Author: rfscholte <rf...@apache.org>
AuthorDate: Fri Jul 5 15:44:09 2019 +0200

    [JXR-145] Add missing interface
---
 .../java/org/apache/maven/jxr/CodeTransformer.java | 54 ++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/CodeTransformer.java b/maven-jxr/src/main/java/org/apache/maven/jxr/CodeTransformer.java
new file mode 100644
index 0000000..be79907
--- /dev/null
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/CodeTransformer.java
@@ -0,0 +1,54 @@
+package org.apache.maven.jxr;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.Locale;
+import java.util.Set;
+
+/**
+ * The code transformer, responsible to turn code into JXR documentation
+ * 
+ * @author Robert Scholte
+ * @since 3.1.0
+ */
+public interface CodeTransformer
+{
+    /**
+     * This is the public method for doing all transforms of code.
+     *
+     * @param sourcefile String
+     * @param destfile String
+     * @param locale String
+     * @param inputEncoding String
+     * @param outputEncoding String
+     * @param javadocLinkDir String
+     * @param bottom TODO
+     * @throws IOException
+     */
+    void transform( Path sourcefile, Path destfile, Locale locale, String inputEncoding, String outputEncoding,
+                    Path javadocLinkDir, String bottom )
+        throws IOException;
+    
+    Set<String> getDefaultIncludes();
+    
+    boolean canTransform( String fileExtension );
+}
\ No newline at end of file