Add JDK 9 module name - fix #291

Add "9" profile to allow building on JDK 9.
Override new JDK 9 Socket methods in WriteTimeoutSocket.
Fix more complaints from JDK 9 javadoc.
Everything here depends on javax.activation.
Upgrade copyright plugin version.

Author: bshannon

android/activation/pom.xml

@@ -109,8 +109,8 @@
 		    <execution>
 			<id>default-compile</id>
 			<configuration>
-			    <source>1.5</source>
-			    <target>1.5</target>
+			    <source>1.7</source>
+			    <target>1.7</target>
 			    <fork>true</fork>
 			    <!--
 				ignore some of the errors that are
@@ -130,8 +130,8 @@
 		    <execution>
 			<id>default-testCompile</id>
 			<configuration>
-			    <source>1.5</source>
-			    <target>1.5</target>
+			    <source>1.7</source>
+			    <target>1.7</target>
 			</configuration>
 		    </execution>
 		</executions>

android/mail/src/main/java/com/sun/mail/handlers/handler_base.java

@@ -51,12 +51,19 @@ public abstract class handler_base implements DataContentHandler {
     /**
      * Return an array of ActivationDataFlavors that we support.
      * Usually there will be only one.
+     *
+     * @return	array of ActivationDataFlavors that we support
      */
     protected abstract ActivationDataFlavor[] getDataFlavors();
 
     /**
      * Given the flavor that matched, return the appropriate type of object.
      * Usually there's only one flavor so just call getContent.
+     *
+     * @param	aFlavor	the ActivationDataFlavor
+     * @param	ds	DataSource containing the data
+     * @return	the object
+     * @exception	IOException	for errors reading the data
      */
     protected Object getData(ActivationDataFlavor aFlavor, DataSource ds)
 				throws IOException {
@@ -75,9 +82,10 @@ public ActivationDataFlavor[] getTransferDataFlavors() {
     /**
      * Return the Transfer Data of type DataFlavor from InputStream.
      *
-     * @param df The DataFlavor
-     * @param ds The DataSource corresponding to the data
-     * @return String object
+     * @param	df	The DataFlavor
+     * @param	ds	The DataSource corresponding to the data
+     * @return	the object
+     * @exception	IOException	for errors reading the data
      */
     public Object getTransferData(ActivationDataFlavor df, DataSource ds) 
 			throws IOException {

android/pom.xml

@@ -76,12 +76,32 @@
 	<android.version>4.4_r1</android.version>
     </properties>
 
+    <profiles>
+	<!--
+	    A special profile for compiling with JDK 9.
+	    Skip animal-sniffer until it works with JDK 9.
+	-->
+	<profile>
+	    <id>9</id>
+	    <build>
+		<plugins>
+		    <plugin>
+			<groupId>org.codehaus.mojo</groupId>
+			<artifactId>animal-sniffer-maven-plugin</artifactId>
+			<configuration>
+			    <skip>true</skip>
+			</configuration>
+		    </plugin>
+		</plugins>
+	    </build>
+	</profile>
+    </profiles>
+
     <build>
 	<plugins>
 	    <plugin>
 		<groupId>org.codehaus.mojo</groupId>
 		<artifactId>animal-sniffer-maven-plugin</artifactId>
-		<version>1.14</version>
 		<executions>
 		    <execution>
 			<id>check-sig</id>
@@ -100,6 +120,16 @@
 		</configuration>
 	    </plugin>
 	</plugins>
+
+	<pluginManagement>
+	    <plugins>
+		<plugin>
+		    <groupId>org.codehaus.mojo</groupId>
+		    <artifactId>animal-sniffer-maven-plugin</artifactId>
+		    <version>1.16</version>
+		</plugin>
+	    </plugins>
+	</pluginManagement>
     </build>
 
 </project>

doc/release/CHANGES.txt

@@ -24,6 +24,7 @@ GH  278	BODYSTRUCTURE Parser fails on specific IMAP Server response
 GH  283	clean up connections when closing IMAPStore
 GH  287	Allow relaxed Content-Disposition parsing
 GH  289	use a different IMAP tag prefix for each connection
+GH  291	define JDK 9 module name for JavaMail
 
 
 		  CHANGES IN THE 1.6.0 RELEASE

mail/pom.xml

@@ -57,10 +57,12 @@
     <name>JavaMail API</name>
 
     <properties>
-	<activation-api.version>1.1</activation-api.version>
 	<mail.extensionName>
 	    javax.mail
 	</mail.extensionName>
+	<mail.moduleName>
+	    java.mail
+	</mail.moduleName>
 	<mail.specificationTitle>
 	    JavaMail(TM) API Design Specification
 	</mail.specificationTitle>
@@ -112,6 +114,9 @@
 					<exclude>
 					  javax/mail/MailSessionDefinitions.java
 					</exclude>
+					<exclude>
+					  module-info.java
+					</exclude>
 				    </excludes>
 				</configuration>
 			    </execution>
@@ -120,6 +125,36 @@
 		</plugins>
 	    </build>
 	</profile>
+
+	<!--
+	    A special profile for compiling with the real JDK 9 compiler.
+	-->
+	<profile>
+	    <id>9</id>
+	    <build>
+		<plugins>
+		    <plugin>
+			<artifactId>maven-compiler-plugin</artifactId>
+			<executions>
+			    <execution>
+				<id>default-compile</id>
+				<configuration>
+				    <compilerArgs>
+					<arg>-Xlint</arg>
+					<arg>-Xlint:-options</arg>
+					<arg>-Xlint:-path</arg>
+					<!--
+					    Too many finalize warnings.
+					<arg>-Werror</arg>
+					-->
+				    </compilerArgs>
+				</configuration>
+			    </execution>
+			</executions>
+		    </plugin>
+		</plugins>
+	    </build>
+	</profile>
     </profiles>
 
     <build>
@@ -150,6 +185,11 @@
 		    </compilerArgs>
 		    <showDeprecation>true</showDeprecation>
 		    <showWarnings>true</showWarnings>
+		    <excludes>
+			<exclude>
+			  module-info.java
+			</exclude>
+		    </excludes>
 		</configuration>
 	    </plugin>
 
@@ -166,14 +206,29 @@
 		    </includes>
 		</configuration>
 	    </plugin>
+
+	    <!--
+		Add the Automatic-Module-Name manifest header for JDK 9.
+	    -->
+	    <plugin>
+		<artifactId>maven-jar-plugin</artifactId>
+		<configuration>
+		    <archive>
+			<manifestEntries>
+			    <Automatic-Module-Name>
+				${mail.moduleName}
+			    </Automatic-Module-Name>
+			</manifestEntries>
+		    </archive>
+		</configuration>
+	    </plugin>
 	</plugins>
     </build>
 
     <dependencies>
 	<dependency>
 	    <groupId>javax.activation</groupId>
 	    <artifactId>activation</artifactId>
-	    <version>${activation-api.version}</version>
 	</dependency>
 	<dependency>
 	    <groupId>junit</groupId>

mail/src/main/java/com/sun/mail/handlers/handler_base.java

@@ -52,12 +52,19 @@ public abstract class handler_base implements DataContentHandler {
     /**
      * Return an array of ActivationDataFlavors that we support.
      * Usually there will be only one.
+     *
+     * @return	array of ActivationDataFlavors that we support
      */
     protected abstract ActivationDataFlavor[] getDataFlavors();
 
     /**
      * Given the flavor that matched, return the appropriate type of object.
      * Usually there's only one flavor so just call getContent.
+     *
+     * @param	aFlavor	the ActivationDataFlavor
+     * @param	ds	DataSource containing the data
+     * @return	the object
+     * @exception	IOException	for errors reading the data
      */
     protected Object getData(ActivationDataFlavor aFlavor, DataSource ds)
 				throws IOException {
@@ -82,9 +89,10 @@ public DataFlavor[] getTransferDataFlavors() {
     /**
      * Return the Transfer Data of type DataFlavor from InputStream.
      *
-     * @param df The DataFlavor
-     * @param ds The DataSource corresponding to the data
-     * @return String object
+     * @param	df	The DataFlavor
+     * @param	ds	The DataSource corresponding to the data
+     * @return	the object
+     * @exception	IOException	for errors reading the data
      */
     @Override
     public Object getTransferData(DataFlavor df, DataSource ds) 

mail/src/main/java/com/sun/mail/iap/Protocol.java

@@ -578,6 +578,7 @@ public SocketChannel getChannel() {
      * This implementation returns false.
      * Subclasses should override as appropriate.
      *
+     * @return	true if the server supports UTF-8
      * @since JavaMail 1.6.0
      */
     public boolean supportsUtf8() {

mail/src/main/java/com/sun/mail/iap/Response.java

@@ -106,6 +106,8 @@ public Response(String s) {
     /**
      * Constructor for testing.
      *
+     * @param	s	the response string
+     * @param	supportsUtf8	allow UTF-8 in response?
      * @since	JavaMail 1.6.0
      */
     public Response(String s, boolean supportsUtf8) {
@@ -171,6 +173,7 @@ public static Response byeResponse(Exception ex) {
     /**
      * Does the server support UTF-8?
      *
+     * @return		true if the server supports UTF-8
      * @since	JavaMail 1.6.0
      */
     public boolean supportsUtf8() {
@@ -224,6 +227,9 @@ public void skipSpaces() {
      * Skip past any spaces.  If the next non-space character is c,
      * consume it and return true.  Otherwise stop at that point
      * and return false.
+     *
+     * @param	c	the character to look for
+     * @return		true if the character is found
      */
     public boolean isNextNonSpace(char c) {
 	skipSpaces();

mail/src/main/java/com/sun/mail/imap/protocol/IMAPProtocol.java

@@ -222,6 +222,8 @@ public void capability() throws ProtocolException {
 
     /**
      * Handle any untagged CAPABILITY response in the Response array.
+     *
+     * @param	r	the responses
      */
     public void handleCapabilityResponse(Response[] r) {
 	boolean first = true;
@@ -1174,6 +1176,8 @@ public void compress() throws ProtocolException {
      * the server supports UTF-8, and add the encoded name to the
      * Argument.
      *
+     * @param	args	the arguments
+     * @param	name	the name to encode
      * @since	JavaMail 1.6.0
      */
     protected void writeMailboxName(Argument args, String name) {

mail/src/main/java/com/sun/mail/smtp/package.html

@@ -162,7 +162,7 @@
 message type with a "message/delivery-status"
 (<A HREF="http://www.ietf.org/rfc/rfc1894.txt" TARGET="_top">RFC 1894</A>)
 part.
-You can use the classes in the {@link com.sun.mail.dsn} package to
+You can use the classes in the <code>com.sun.mail.dsn</code> package to
 handle these MIME types.
 Note that you'll need to include <code>dsn.jar</code> in your CLASSPATH
 as this support is not included in <code>mail.jar</code>.

mail/src/main/java/com/sun/mail/util/LineInputStream.java

@@ -68,6 +68,8 @@ public LineInputStream(InputStream in) {
     }
 
     /**
+     * @param	in	the InputStream
+     * @param	allowutf8	allow UTF-8 characters?
      * @since	JavaMail 1.6
      */
     public LineInputStream(InputStream in, boolean allowutf8) {

mail/src/main/java/com/sun/mail/util/LineOutputStream.java

@@ -71,6 +71,8 @@ public LineOutputStream(OutputStream out) {
     }
 
     /**
+     * @param	out	the OutputStream
+     * @param	allowutf8	allow UTF-8 characters?
      * @since	JavaMail 1.6
      */
     public LineOutputStream(OutputStream out, boolean allowutf8) {

mail/src/main/java/com/sun/mail/util/WriteTimeoutSocket.java

@@ -43,6 +43,8 @@
 import java.io.*;
 import java.net.*;
 import java.util.concurrent.*;
+import java.util.Collections;
+import java.util.Set;
 import java.nio.channels.SocketChannel;
 import java.lang.reflect.*;
 
@@ -314,8 +316,34 @@ public boolean isOutputShutdown() {
         return socket.isOutputShutdown();
     }
 
+    /*
+     * The following three methods were added to java.net.Socket in Java SE 9.
+     * Since they're not supported on Android, and since we know that we
+     * never use them in JavaMail, we just stub them out here.
+     */
+    //@Override
+    public <T> Socket setOption(SocketOption<T> so, T val) throws IOException {
+	// socket.setOption(so, val);
+	// return this;
+	throw new UnsupportedOperationException("WriteTimeoutSocket.setOption");
+    }
+
+    //@Override
+    public <T> T getOption(SocketOption<T> so) throws IOException {
+	// return socket.getOption(so);
+	throw new UnsupportedOperationException("WriteTimeoutSocket.getOption");
+    }
+
+    //@Override
+    public Set<SocketOption<?>> supportedOptions() {
+	// return socket.supportedOptions();
+	return Collections.emptySet();
+    }
+
     /**
      * KLUDGE for Android, which has this illegal non-Java Compatible method.
+     *
+     * @return	the FileDescriptor object
      */
     public FileDescriptor getFileDescriptor$() {
 	try {