Skip to content
Permalink
Browse files
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
  • Loading branch information
garydgregory committed Dec 10, 2019
1 parent 1cc064d commit ade390e0205384033b9c4dc07ddd1d3da55c7911
Show file tree
Hide file tree
Showing 12 changed files with 96 additions and 96 deletions.
@@ -20,23 +20,23 @@
import java.io.IOException;

/**
* Creates a <code>DataSource</code> based on an URL.
* Creates a {@code DataSource} based on an URL.
*
* @since 1.3
*/
public interface DataSourceResolver
{
/**
* Resolves the given resource location to a <code>DataSource</code>.
* Resolves the given resource location to a {@code DataSource}.
*
* @param resourceLocation the location of the resource
* @return the <code>DataSource</code>
* @return the {@code DataSource}
* @throws IOException the resource was not found
*/
DataSource resolve(final String resourceLocation) throws IOException;

/**
* Resolves the given resource location to a <code>DataSource</code>.
* Resolves the given resource location to a {@code DataSource}.
*
* @param resourceLocation the location of the resource
* @param isLenient shall we ignore resources not found or complain with an exception?
@@ -46,7 +46,7 @@ public DefaultAuthenticator(final String userName, final String password)
* Gets the authentication object that will be used to login to the mail
* server.
*
* @return A <code>PasswordAuthentication</code> object containing the
* @return A {@code PasswordAuthentication} object containing the
* login information.
* @since 1.0
*/
@@ -198,7 +198,7 @@
protected Date sentDate;

/**
* Instance of an <code>Authenticator</code> object that will be used
* Instance of an {@code Authenticator} object that will be used
* when authentication is requested from the mail server.
*/
protected Authenticator authenticator;
@@ -236,8 +236,8 @@
/**
* Address to which undeliverable mail should be sent.
* Because this is handled by JavaMail as a String property
* in the mail session, this property is of type <code>String</code>
* rather than <code>InternetAddress</code>.
* in the mail session, this property is of type {@code String}
* rather than {@code InternetAddress}.
*/
protected String bounceAddress;

@@ -341,7 +341,7 @@ public void setDebug(final boolean d)
* method is not used, no authentication will be performed.
* <p>
* This method will create a new instance of
* <code>DefaultAuthenticator</code> using the supplied parameters.
* {@code DefaultAuthenticator} using the supplied parameters.
*
* @param userName User name for the SMTP server
* @param password password for the SMTP server
@@ -355,13 +355,13 @@ public void setAuthentication(final String userName, final String password)
}

/**
* Sets the <code>Authenticator</code> to be used when authentication
* Sets the {@code Authenticator} to be used when authentication
* is requested from the mail server.
* <p>
* This method should be used when your outgoing mail server requires
* authentication. Your mail server must also support RFC2554.
*
* @param newAuthenticator the <code>Authenticator</code> object.
* @param newAuthenticator the {@code Authenticator} object.
* @see Authenticator
* @since 1.0
*/
@@ -849,10 +849,10 @@ public Email addTo(final String email, final String name, final String charset)

/**
* Set a list of "TO" addresses. All elements in the specified
* <code>Collection</code> are expected to be of type
* <code>java.mail.internet.InternetAddress</code>.
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
* @param aCollection collection of <code>InternetAddress</code> objects.
* @param aCollection collection of {@code InternetAddress} objects.
* @return An Email.
* @throws EmailException Indicates an invalid email address.
* @see javax.mail.internet.InternetAddress
@@ -958,10 +958,10 @@ public Email addCc(final String email, final String name, final String charset)

/**
* Set a list of "CC" addresses. All elements in the specified
* <code>Collection</code> are expected to be of type
* <code>java.mail.internet.InternetAddress</code>.
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
* @param aCollection collection of <code>InternetAddress</code> objects.
* @param aCollection collection of {@code InternetAddress} objects.
* @return An Email.
* @throws EmailException Indicates an invalid email address.
* @see javax.mail.internet.InternetAddress
@@ -1067,10 +1067,10 @@ public Email addBcc(final String email, final String name, final String charset)

/**
* Set a list of "BCC" addresses. All elements in the specified
* <code>Collection</code> are expected to be of type
* <code>java.mail.internet.InternetAddress</code>.
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
* @param aCollection collection of <code>InternetAddress</code> objects
* @param aCollection collection of {@code InternetAddress} objects
* @return An Email.
* @throws EmailException Indicates an invalid email address
* @see javax.mail.internet.InternetAddress
@@ -1146,10 +1146,10 @@ public Email addReplyTo(final String email, final String name, final String char

/**
* Set a list of reply to addresses. All elements in the specified
* <code>Collection</code> are expected to be of type
* <code>java.mail.internet.InternetAddress</code>.
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
* @param aCollection collection of <code>InternetAddress</code> objects
* @param aCollection collection of {@code InternetAddress} objects
* @return An Email.
* @throws EmailException Indicates an invalid email address
* @see javax.mail.internet.InternetAddress
@@ -37,7 +37,7 @@
private static final long serialVersionUID = 5550674499282474616L;

/**
* Constructs a new <code>EmailException</code> with no
* Constructs a new {@code EmailException} with no
* detail message.
*/
public EmailException()
@@ -46,7 +46,7 @@ public EmailException()
}

/**
* Constructs a new <code>EmailException</code> with specified
* Constructs a new {@code EmailException} with specified
* detail message.
*
* @param msg the error message.
@@ -57,8 +57,8 @@ public EmailException(final String msg)
}

/**
* Constructs a new <code>EmailException</code> with specified
* nested <code>Throwable</code> root cause.
* Constructs a new {@code EmailException} with specified
* nested {@code Throwable} root cause.
*
* @param rootCause the exception or error that caused this exception
* to be thrown.
@@ -69,8 +69,8 @@ public EmailException(final Throwable rootCause)
}

/**
* Constructs a new <code>EmailException</code> with specified
* detail message and nested <code>Throwable</code> root cause.
* Constructs a new {@code EmailException} with specified
* detail message and nested {@code Throwable} root cause.
*
* @param msg the error message.
* @param rootCause the exception or error that caused this exception
@@ -93,7 +93,7 @@ public void printStackTrace()
/**
* Prints the stack trace of this exception to the specified stream.
*
* @param out the <code>PrintStream</code> to use for output
* @param out the {@code PrintStream} to use for output
*/
@Override
public void printStackTrace(final PrintStream out)
@@ -111,7 +111,7 @@ public void printStackTrace(final PrintStream out)
/**
* Prints the stack trace of this exception to the specified writer.
*
* @param out the <code>PrintWriter</code> to use for output
* @param out the {@code PrintWriter} to use for output
*/
@Override
public void printStackTrace(final PrintWriter out)
@@ -103,7 +103,7 @@
}

/**
* Constructs a new <code>EmailException</code> with no detail message.
* Constructs a new {@code EmailException} with no detail message.
*/
private EmailUtils()
{
@@ -115,7 +115,7 @@ private EmailUtils()
*
* @param str the String to check, may be null
*
* @return <code>true</code> if the String is empty or null
* @return {@code true} if the String is empty or null
*
* @since Commons Lang v2.1, svn 240418
*/
@@ -129,7 +129,7 @@ static boolean isEmpty(final String str)
*
* @param str the String to check, may be null
*
* @return <code>true</code> if the String is not empty and not null
* @return {@code true} if the String is not empty and not null
*
* @since Commons Lang v2.1, svn 240418
*/
@@ -139,13 +139,13 @@ static boolean isNotEmpty(final String str)
}

/**
* Validate an argument, throwing <code>IllegalArgumentException</code>
* if the argument is <code>null</code>.
* Validate an argument, throwing {@code IllegalArgumentException}
* if the argument is {@code null}.
*
* @param object the object to check is not <code>null</code>
* @param message the exception message you would like to see if the object is <code>null</code>
* @param object the object to check is not {@code null}
* @param message the exception message you would like to see if the object is {@code null}
*
* @throws IllegalArgumentException if the object is <code>null</code>
* @throws IllegalArgumentException if the object is {@code null}
*
* @since Commons Lang v2.1, svn 201930
*/
@@ -179,13 +179,13 @@ static String randomAlphabetic(final int count)
* Creates a random string based on a variety of options, using supplied source of randomness.
*
* <p>
* If start and end are both <code>0</code>, start and end are set to <code>' '</code> and <code>'z'</code>,
* the ASCII printable characters, will be used, unless letters and numbers are both <code>false</code>,
* in which case, start and end are set to <code>0</code> and <code>Integer.MAX_VALUE</code>.
* If start and end are both {@code 0}, start and end are set to {@code ' '} and {@code 'z'},
* the ASCII printable characters, will be used, unless letters and numbers are both {@code false},
* in which case, start and end are set to {@code 0} and {@code Integer.MAX_VALUE}.
* </p>
*
* <p>
* If set is not <code>null</code>, characters between start and end are chosen.
* If set is not {@code null}, characters between start and end are chosen.
* </p>
*
* <p>
@@ -199,13 +199,13 @@ static String randomAlphabetic(final int count)
* @param end the position in set of chars to end before
* @param letters only allow letters?
* @param numbers only allow numbers?
* @param chars the set of chars to choose randoms from. If <code>null</code>,
* @param chars the set of chars to choose randoms from. If {@code null},
* then it will use the set of all chars.
* @param random a source of randomness.
*
* @return the random string
*
* @throws IllegalArgumentException if <code>count</code> &lt; 0.
* @throws IllegalArgumentException if {@code count} &lt; 0.
*
* @since Commons Lang v2.1, svn 201930
*/

0 comments on commit ade390e

Please sign in to comment.