This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-email.git
commit 16518ce3dad8272c0abd6fde88b7d7f3e2703de8
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Dec 14 10:29:03 2023 -0500
Javadoc
- Internal refactoring
- Format tweaks
- Javadoc
---
src/main/java/org/apache/commons/mail/Email.java | 6 +++---
src/main/java/org/apache/commons/mail/EmailConstants.java | 2 +-
src/main/java/org/apache/commons/mail/HtmlEmail.java | 2 +-
.../commons/mail/resolver/DataSourceClassPathResolver.java | 2 +-
.../commons/mail/resolver/DataSourceCompositeResolver.java | 2 +-
.../apache/commons/mail/resolver/DataSourceFileResolver.java | 2 +-
.../apache/commons/mail/resolver/DataSourceUrlResolver.java | 11 +++--------
.../java/org/apache/commons/mail/util/MimeMessageParser.java | 12 +++++++++---
.../java/org/apache/commons/mail/util/MimeMessageUtils.java | 1 +
9 files changed, 21 insertions(+), 19 deletions(-)
diff --git a/src/main/java/org/apache/commons/mail/Email.java
b/src/main/java/org/apache/commons/mail/Email.java
index 3466d3a..3d3aba3 100644
--- a/src/main/java/org/apache/commons/mail/Email.java
+++ b/src/main/java/org/apache/commons/mail/Email.java
@@ -248,13 +248,13 @@ public abstract class Email {
*/
protected boolean popBeforeSmtp;
- /** the host name of the pop3 server. */
+ /** The host name of the pop3 server. */
protected String popHost;
- /** the user name to log into the pop3 server. */
+ /** The user name to log into the pop3 server. */
protected String popUsername;
- /** the password to log into the pop3 server. */
+ /** The password to log into the pop3 server. */
protected String popPassword;
/**
diff --git a/src/main/java/org/apache/commons/mail/EmailConstants.java
b/src/main/java/org/apache/commons/mail/EmailConstants.java
index 05f3e01..065c0ed 100644
--- a/src/main/java/org/apache/commons/mail/EmailConstants.java
+++ b/src/main/java/org/apache/commons/mail/EmailConstants.java
@@ -99,7 +99,7 @@ public final class EmailConstants {
/** Specifies the default transport protocol */
public static final String MAIL_TRANSPORT_PROTOCOL =
"mail.transport.protocol";
- /** the value to use SMTP as transport protocol */
+ /** The value to use SMTP as transport protocol */
public static final String SMTP = "smtp";
/** defines the text/html content type */
diff --git a/src/main/java/org/apache/commons/mail/HtmlEmail.java
b/src/main/java/org/apache/commons/mail/HtmlEmail.java
index 4596597..d3c6fb1 100644
--- a/src/main/java/org/apache/commons/mail/HtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/HtmlEmail.java
@@ -92,7 +92,7 @@ public class HtmlEmail extends MultiPartEmail {
/** {@code DataSource} for the content. */
private final DataSource dataSource;
- /** the {@code MimeBodyPart} that contains the encoded data. */
+ /** The {@code MimeBodyPart} that contains the encoded data. */
private final MimeBodyPart mbp;
/**
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
index 1a14431..a86e19f 100644
---
a/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
+++
b/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
@@ -30,7 +30,7 @@ import javax.mail.util.ByteArrayDataSource;
* @since 1.3
*/
public class DataSourceClassPathResolver extends DataSourceBaseResolver {
- /** the base string of the resource relative to the classpath when
resolving relative paths */
+ /** The base string of the resource relative to the classpath when
resolving relative paths */
private final String classPathBase;
/**
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
index 22a1466..ca0c943 100644
---
a/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
+++
b/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
@@ -28,7 +28,7 @@ import org.apache.commons.mail.DataSourceResolver;
* @since 1.3
*/
public class DataSourceCompositeResolver extends DataSourceBaseResolver {
- /** the list of resolvers */
+ /** The list of resolvers */
private final DataSourceResolver[] dataSourceResolvers;
/**
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
index 9c1f0d8..fd4b547 100644
--- a/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
+++ b/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
@@ -28,7 +28,7 @@ import javax.activation.FileDataSource;
* @since 1.3
*/
public class DataSourceFileResolver extends DataSourceBaseResolver {
- /** the base directory of the resource when resolving relative paths */
+ /** The base directory of the resource when resolving relative paths */
private final File baseDir;
/**
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
index 924456a..c572946 100644
--- a/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
+++ b/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
@@ -29,7 +29,8 @@ import javax.activation.URLDataSource;
* @since 1.3
*/
public class DataSourceUrlResolver extends DataSourceBaseResolver {
- /** the base url of the resource when resolving relative paths */
+
+ /** The base url of the resource when resolving relative paths */
private final URL baseUrl;
/**
@@ -65,17 +66,14 @@ public class DataSourceUrlResolver extends
DataSourceBaseResolver {
if (baseUrl == null) {
return new URL(resourceLocation);
}
-
// if we get an non-existing location what we shall do?
if (resourceLocation == null || resourceLocation.isEmpty()) {
throw new IllegalArgumentException("No resource defined");
}
-
// if we get a stand-alone resource than ignore the base url
if (isFileUrl(resourceLocation) || isHttpUrl(resourceLocation)) {
return new URL(resourceLocation);
}
-
return new URL(getBaseUrl(), resourceLocation.replace("&", "&"));
}
@@ -98,14 +96,11 @@ public class DataSourceUrlResolver extends
DataSourceBaseResolver {
@Override
public DataSource resolve(final String resourceLocation, final boolean
isLenient) throws IOException {
DataSource result = null;
-
try {
if (!isCid(resourceLocation)) {
- final URL url = createUrl(resourceLocation);
- result = new URLDataSource(url);
+ result = new URLDataSource(createUrl(resourceLocation));
result.getInputStream();
}
-
return result;
} catch (final IOException e) {
if (isLenient) {
diff --git a/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
b/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
index 1b6446e..eeace55 100644
--- a/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
+++ b/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
@@ -55,7 +55,7 @@ public class MimeMessageParser {
/** Plain mail content from MimeMessage */
private String plainContent;
- /** Html mail content from MimeMessage */
+ /** HTML mail content from MimeMessage */
private String htmlContent;
/** List of attachments of MimeMessage */
@@ -104,6 +104,7 @@ public class MimeMessageParser {
* Find an attachment using its content-id.
* <p>
* The content-id must be stripped of any angle brackets, i.e. "part1"
instead of "<part1>".
+ * </p>
*
* @param cid the content-id of the attachment
* @return the corresponding datasource or null if nothing was found
@@ -168,6 +169,7 @@ public class MimeMessageParser {
* Returns a collection of all content-ids in the parsed message.
* <p>
* The content-ids are stripped of any angle brackets, i.e. "part1"
instead of "<part1>".
+ * </p>
*
* @return the collection of content ids.
* @since 1.3.4
@@ -204,7 +206,7 @@ public class MimeMessageParser {
*/
public String getFrom() throws MessagingException {
final Address[] addresses = mimeMessage.getFrom();
- if (addresses == null || addresses.length == 0) {
+ if (isEmpty(addresses)) {
return null;
}
return ((InternetAddress) addresses[0]).getAddress();
@@ -231,7 +233,7 @@ public class MimeMessageParser {
*/
public String getReplyTo() throws MessagingException {
final Address[] addresses = mimeMessage.getReplyTo();
- if (addresses == null || addresses.length == 0) {
+ if (isEmpty(addresses)) {
return null;
}
return ((InternetAddress) addresses[0]).getAddress();
@@ -268,6 +270,10 @@ public class MimeMessageParser {
return plainContent != null;
}
+ private boolean isEmpty(final Object[] array) {
+ return array == null || array.length == 0;
+ }
+
/**
* Checks whether the MimePart contains an object of the given mime type.
*
diff --git a/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
b/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
index d773009..f1ab564 100644
--- a/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
+++ b/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
@@ -35,6 +35,7 @@ import javax.mail.internet.MimeMessage;
* @since 1.3
*/
public final class MimeMessageUtils {
+
/**
* Creates a MimeMessage.
*
