[tomcat-jakartaee-migration] branch main updated: Updates for javadoc 18+

[remm]

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

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


The following commit(s) were added to refs/heads/main by this push:
 new 32474b4  Updates for javadoc 18+
32474b4 is described below

commit 32474b4a967ccac41f0933d64ab78ef5c6e2a1b6
Author: remm 
AuthorDate: Thu Nov 3 16:35:12 2022 +0100

Updates for javadoc 18+

This is particularly annoying, especially the "warning: use of default
constructor, which does not provide a comment" which means adding the
default constructor just to comment on it (!!). This cannot be disabled
except by filtering out a lot more.
I don't think it is realistic to do this for Tomcat.
---
 .../apache/tomcat/jakartaee/ClassConverter.java| 25 +
 .../org/apache/tomcat/jakartaee/Converter.java |  8 
 .../org/apache/tomcat/jakartaee/EESpecProfile.java | 20 ++
 .../apache/tomcat/jakartaee/EESpecProfiles.java|  9 +
 .../org/apache/tomcat/jakartaee/GlobMatcher.java   |  7 
 .../java/org/apache/tomcat/jakartaee/Info.java |  7 
 .../apache/tomcat/jakartaee/ManifestConverter.java |  5 +++
 .../org/apache/tomcat/jakartaee/Migration.java | 43 +-
 .../org/apache/tomcat/jakartaee/MigrationCLI.java  | 13 +++
 .../org/apache/tomcat/jakartaee/MigrationTask.java | 21 +++
 .../tomcat/jakartaee/PassThroughConverter.java |  8 
 .../org/apache/tomcat/jakartaee/TextConverter.java |  7 
 .../java/org/apache/tomcat/jakartaee/Util.java | 16 
 13 files changed, 188 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/tomcat/jakartaee/ClassConverter.java 
b/src/main/java/org/apache/tomcat/jakartaee/ClassConverter.java
index e07814f..47fae3c 100644
--- a/src/main/java/org/apache/tomcat/jakartaee/ClassConverter.java
+++ b/src/main/java/org/apache/tomcat/jakartaee/ClassConverter.java
@@ -33,15 +33,30 @@ import org.apache.bcel.classfile.ConstantUtf8;
 import org.apache.bcel.classfile.JavaClass;
 import org.apache.commons.io.IOUtils;
 
+/**
+ * Class converter and transformer.
+ */
 public class ClassConverter implements Converter, ClassFileTransformer {
 
 private static final Logger logger = 
Logger.getLogger(ClassConverter.class.getCanonicalName());
 private static final StringManager sm = 
StringManager.getManager(ClassConverter.class);
 
+/**
+ * The configured spec profile.
+ */
 protected final EESpecProfile profile;
+
+/**
+ * Create a class converter with the default TOMCAT profile.
+ */
 public ClassConverter() {
 this(EESpecProfiles.TOMCAT);
 }
+
+/**
+ * Create a class converter with the specified spec profile.
+ * @param profile the specification profile to use for conversion
+ */
 public ClassConverter(EESpecProfile profile) {
 this.profile = profile;
 }
@@ -79,6 +94,16 @@ public class ClassConverter implements Converter, 
ClassFileTransformer {
 }
 
 
+/**
+ * Convert specified class bytecode.
+ * @param path the path
+ * @param src the source byte stream
+ * @param dest the output byte stream
+ * @param profile the specification profile to use
+ * @param loader the class loader
+ * @return true if conversion occurred
+ * @throws IOException rethrow on byte read or write
+ */
 protected boolean convertInternal(String path, InputStream src, 
OutputStream dest, EESpecProfile profile, ClassLoader loader)
 throws IOException {
 byte[] classBytes = IOUtils.toByteArray(src);
diff --git a/src/main/java/org/apache/tomcat/jakartaee/Converter.java 
b/src/main/java/org/apache/tomcat/jakartaee/Converter.java
index 1bba1a1..c96ae09 100644
--- a/src/main/java/org/apache/tomcat/jakartaee/Converter.java
+++ b/src/main/java/org/apache/tomcat/jakartaee/Converter.java
@@ -20,8 +20,16 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 
+/**
+ * The main Converter interface, used for package prefix conversion.
+ */
 public interface Converter {
 
+/**
+ * Check if the file can be processed by this converter.
+ * @param filename the file name
+ * @return true if the converter will process this file
+ */
 boolean accepts(String filename);
 
 /**
diff --git a/src/main/java/org/apache/tomcat/jakartaee/EESpecProfile.java 
b/src/main/java/org/apache/tomcat/jakartaee/EESpecProfile.java
index 321e8cb..34ba3a2 100644
--- a/src/main/java/org/apache/tomcat/jakartaee/EESpecProfile.java
+++ b/src/main/java/org/apache/tomcat/jakartaee/EESpecProfile.java
@@ -20,16 +20,36 @@ package org.apache.tomcat.jakartaee;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+/**
+ * Used to represent a specification profile.
+ */
 public interface EESpecProfile {
+/**
+ * Convert the specified name to the target namesp

[tomcat-jakartaee-migration] branch main updated: Add in memory test

[remm]

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

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


The following commit(s) were added to refs/heads/main by this push:
 new c6002b4  Add in memory test
c6002b4 is described below

commit c6002b4c1bebb8b6b69b569d43a8e11c8e016a27
Author: remm 
AuthorDate: Thu Nov 3 16:50:17 2022 +0100

Add in memory test
---
 .../java/org/apache/tomcat/jakartaee/MigrationTest.java | 17 ++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/src/test/java/org/apache/tomcat/jakartaee/MigrationTest.java 
b/src/test/java/org/apache/tomcat/jakartaee/MigrationTest.java
index 9987c2e..34048bb 100644
--- a/src/test/java/org/apache/tomcat/jakartaee/MigrationTest.java
+++ b/src/test/java/org/apache/tomcat/jakartaee/MigrationTest.java
@@ -156,21 +156,27 @@ public class MigrationTest {
 
 @Test
 public void testMigrateJarFile() throws Exception {
+testMigrateJarFileInternal(false);
+}
+
+private void testMigrateJarFileInternal(boolean zipInMemory) throws 
Exception {
 File jarFile = new File("target/test-classes/hellocgi.jar");
+File jarFileTarget = new 
File("target/test-classes/hellocgi-target.jar");
 
 Migration migration = new Migration();
 migration.setSource(jarFile);
-migration.setDestination(jarFile);
+migration.setDestination(jarFileTarget);
+migration.setZipInMemory(zipInMemory);
 migration.execute();
 
 File cgiapiFile = new File("target/test-classes/cgi-api.jar");
-URLClassLoader classloader = new URLClassLoader(new 
URL[]{jarFile.toURI().toURL(), 
cgiapiFile.toURI().toURL()},ClassLoader.getSystemClassLoader().getParent());
+URLClassLoader classloader = new URLClassLoader(new 
URL[]{jarFileTarget.toURI().toURL(), 
cgiapiFile.toURI().toURL()},ClassLoader.getSystemClassLoader().getParent());
 
 Class cls = Class.forName("org.apache.tomcat.jakartaee.HelloCGI", 
true, classloader);
 assertEquals("jakarta.servlet.CommonGatewayInterface", 
cls.getSuperclass().getName());
 
 // check the modification of the Implementation-Version manifest 
attribute
-try (JarFile jar = new JarFile(jarFile)) {
+try (JarFile jar = new JarFile(jarFileTarget)) {
 String implementationVersion = 
jar.getManifest().getMainAttributes().getValue("Implementation-Version");
 assertNotNull("Missing Implementation-Version manifest attribute", 
implementationVersion);
 assertNotEquals("Implementation-Version manifest attribute not 
changed", "1.2.3", implementationVersion);
@@ -180,6 +186,11 @@ public class MigrationTest {
 assertTrue("hasConverted should be true", migration.hasConverted());
 }
 
+@Test
+public void testMigrateJarFileInMemory() throws Exception {
+testMigrateJarFileInternal(true);
+}
+
 @Test
 public void testHasConversionsThrowsWhenNotComplete() {
 Migration migration = new Migration();


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