You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2021/04/18 08:25:39 UTC

[maven-jxr] 04/04: Change encoding type from String to CharSet

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

commit 6aa6b7fbacc70bab776e1196b797b496cca64003
Author: rfscholte <rf...@apache.org>
AuthorDate: Sun Apr 18 10:25:14 2021 +0200

    Change encoding type from String to CharSet
---
 .../src/main/java/org/apache/maven/jxr/JavaCodeTransform.java      | 3 ++-
 .../src/main/java/org/apache/maven/jxr/pacman/FileManager.java     | 7 ++++---
 maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java  | 7 ++++---
 .../src/main/java/org/apache/maven/jxr/pacman/JavaFileImpl.java    | 3 ++-
 .../src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java  | 6 +++---
 .../test/java/org/apache/maven/jxr/pacman/JavaFileImplTest.java    | 7 ++++---
 6 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java b/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
index 420ba19..055ddd4 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
@@ -44,6 +44,7 @@ import java.io.PrintWriter;
 import java.io.Reader;
 import java.io.Serializable;
 import java.io.Writer;
+import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Collections;
@@ -468,7 +469,7 @@ public class JavaCodeTransform
         return fw;
     }
 
-    private Reader getReader( Path sourcefile, String inputEncoding )
+    private Reader getReader( Path sourcefile, Charset inputEncoding )
         throws IOException
     {
         Reader fr;
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/FileManager.java b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/FileManager.java
index 6f73616..59b0b94 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/FileManager.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/FileManager.java
@@ -20,6 +20,7 @@ package org.apache.maven.jxr.pacman;
  */
 
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.nio.file.Path;
 import java.util.HashMap;
 import java.util.Map;
@@ -39,7 +40,7 @@ public class FileManager
 {
     private Map<Path, JavaFile> files = new HashMap<>();
 
-    private String encoding = null;
+    private Charset encoding = null;
 
     /**
      * Get a file from it's name. If the file does not exist within the
@@ -73,7 +74,7 @@ public class FileManager
      *
      * @param encoding encoding of source files
      */
-    public void setEncoding( String encoding )
+    public void setEncoding( Charset encoding )
     {
         this.encoding = encoding;
     }
@@ -83,7 +84,7 @@ public class FileManager
      *
      * @see #setEncoding(String)
      */
-    public String getEncoding()
+    public Charset getEncoding()
     {
         return encoding;
     }
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java
index f6a90c9..96a9d5d 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java
@@ -19,6 +19,7 @@ package org.apache.maven.jxr.pacman;
  * under the License.
  */
 
+import java.nio.charset.Charset;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -42,9 +43,9 @@ public abstract class JavaFile
 
     private final Path path;
 
-    private final String encoding;
+    private final Charset encoding;
     
-    protected JavaFile(  Path path, String encoding )
+    protected JavaFile(  Path path, Charset encoding )
     {
         this.path = path;
         this.encoding = encoding;
@@ -137,7 +138,7 @@ public abstract class JavaFile
     /**
      * Gets the encoding attribute of the JavaFile object
      */
-    public String getEncoding()
+    public Charset getEncoding()
     {
         return this.encoding;
     }
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFileImpl.java b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFileImpl.java
index 9a30db5..2bdca8a 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFileImpl.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFileImpl.java
@@ -25,6 +25,7 @@ import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.io.StreamTokenizer;
+import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
@@ -45,7 +46,7 @@ public class JavaFileImpl
      * @param encoding
      * @throws IOException
      */
-    public JavaFileImpl( Path path, String encoding )
+    public JavaFileImpl( Path path, Charset encoding )
         throws IOException
     {
         super( path, encoding );
diff --git a/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java b/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java
index 962d912..141cb64 100644
--- a/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java
+++ b/maven-jxr/src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java
@@ -63,7 +63,7 @@ public class JavaCodeTransformTest
         throws Exception // single line despite /*
     {
         Path sourceFile = Paths.get( "src/test/java/org/apache/maven/jxr/JavaCodeTransformTest.java" );
-        JavaFile javaFile = new JavaFileImpl( sourceFile, "ISO-8859-1" );
+        JavaFile javaFile = new JavaFileImpl( sourceFile, StandardCharsets.ISO_8859_1 );
         assertTrue( /* mid-line comment */ Files.exists( sourceFile ) ); /*
 
         multiline comment text
@@ -81,7 +81,7 @@ public class JavaCodeTransformTest
         throws Exception
     {
         Path sourceFile = Paths.get( "src/test/resources/EmptyClass.java" );
-        JavaFile javaFile = new JavaFileImpl( sourceFile, "ISO-8859-1" );
+        JavaFile javaFile = new JavaFileImpl( sourceFile, StandardCharsets.ISO_8859_1 );
         assertTrue( Files.exists( sourceFile ) );
 
         codeTransform.transform( javaFile, Paths.get( "target/EmptyClass.html" )
@@ -97,7 +97,7 @@ public class JavaCodeTransformTest
         throws Exception
     {
         Path sourceFile = Paths.get( "src/test/resources/ClassWithLink.java" );
-        JavaFile javaFile = new JavaFileImpl( sourceFile, "ISO-8859-1" );
+        JavaFile javaFile = new JavaFileImpl( sourceFile, StandardCharsets.ISO_8859_1 );
         assertTrue( Files.exists( sourceFile ) );
 
         codeTransform.transform( javaFile, Paths.get( "target/ClassWithLink.html" )
diff --git a/maven-jxr/src/test/java/org/apache/maven/jxr/pacman/JavaFileImplTest.java b/maven-jxr/src/test/java/org/apache/maven/jxr/pacman/JavaFileImplTest.java
index 5c3a854..cb09d6e 100644
--- a/maven-jxr/src/test/java/org/apache/maven/jxr/pacman/JavaFileImplTest.java
+++ b/maven-jxr/src/test/java/org/apache/maven/jxr/pacman/JavaFileImplTest.java
@@ -22,6 +22,7 @@ package org.apache.maven.jxr.pacman;
 import org.junit.Test;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Paths;
 import java.util.Iterator;
 
@@ -31,9 +32,9 @@ public class JavaFileImplTest {
     @Test
     public void testJXR_135_lotsOfNested() throws IOException
     {
-        JavaFileImpl javaFile = new JavaFileImpl( Paths.get(
-                "src/test/resources/jxr135/org/apache/maven/jxr/pacman/ClassWithNested.java" ),
-                "UTF-8" );
+        JavaFileImpl javaFile =
+            new JavaFileImpl( Paths.get( "src/test/resources/jxr135/org/apache/maven/jxr/pacman/ClassWithNested.java" ),
+                              StandardCharsets.UTF_8 );
         final Iterator<ClassType> classTypes = javaFile.getClassTypes().iterator();
         assertEquals( "ClassWithNested", classTypes.next().getName() );
         assertEquals( "ClassWithNested.NestedInterface", classTypes.next().getName() );