Javadoc

Author: garydgregory

src/main/java/org/apache/commons/lang3/AutoCloseables.java

@@ -38,7 +38,7 @@ public class AutoCloseables {
      * Closes the given {@link AutoCloseable} as a null-safe operation.
      *
      * @param closeable The resource to close, may be null.
-     * @throws Exception if an error occurs.
+     * @throws Exception Thrown if an error occurs.
      */
     public static void close(final AutoCloseable closeable) throws Exception {
         if (closeable != null) {

src/main/java/org/apache/commons/lang3/ObjectUtils.java

@@ -787,7 +787,7 @@ public static String identityHashCodeHex(final Object object) {
      *
      * @param appendable  The appendable to append to.
      * @param object  The object to create a toString for.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException Thrown if an I/O error occurs.
      * @since 3.2
      */
     public static void identityToString(final Appendable appendable, final Object object) throws IOException {

src/main/java/org/apache/commons/lang3/SerializationUtils.java

@@ -74,7 +74,7 @@ static final class ClassLoaderAwareObjectInputStream extends ObjectInputStream {
          *
          * @param in          The {@link InputStream}.
          * @param classLoader classloader to use
-         * @throws IOException if an I/O error occurs while reading stream header.
+         * @throws IOException Thrown if an I/O error occurs while reading stream header.
          * @see java.io.ObjectInputStream
          */
         ClassLoaderAwareObjectInputStream(final InputStream in, final ClassLoader classLoader) throws IOException {

src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java

@@ -147,7 +147,7 @@ private final class InitializationTask implements Callable<T> {
          * Initiates initialization and returns the result.
          *
          * @return The result object
-         * @throws Exception if an error occurs
+         * @throws Exception Thrown if an error occurs
          */
         @Override
         public T call() throws Exception {

src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java

@@ -118,7 +118,7 @@ protected Exception getTypedException(final Exception e) {
      * Performs initialization in a background thread. This implementation delegates to the {@link Callable} passed at construction time of this object.
      *
      * @return The result of the initialization.
-     * @throws Exception if an error occurs.
+     * @throws Exception Thrown if an error occurs.
      */
     @Override
     protected T initialize() throws Exception {

src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java

@@ -315,7 +315,7 @@ protected int getTaskCount() {
      * the results object. Unchecked exceptions are propagated.
      *
      * @return The results object.
-     * @throws Exception if an error occurs.
+     * @throws Exception Thrown if an error occurs.
      */
     @Override
     protected MultiBackgroundInitializerResults initialize() throws Exception {

src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java

@@ -315,7 +315,7 @@ private void initializeTransientFields(final Class<L> listenerInterface, final C
      * Deserializes the next object into this instance.
      *
      * @param objectInputStream The input stream.
-     * @throws IOException if an IO error occurs.
+     * @throws IOException Thrown if an IO error occurs.
      * @throws ClassNotFoundException if the class cannot be resolved.
      */
     private void readObject(final ObjectInputStream objectInputStream) throws IOException, ClassNotFoundException {
@@ -342,7 +342,7 @@ public void removeListener(final L listener) {
      * Serializes this instance onto the given ObjectOutputStream.
      *
      * @param objectOutputStream The output stream
-     * @throws IOException if an IO error occurs
+     * @throws IOException Thrown if an IO error occurs
      */
     private void writeObject(final ObjectOutputStream objectOutputStream) throws IOException {
         final ArrayList<L> serializableListeners = new ArrayList<>();

src/main/java/org/apache/commons/lang3/text/StrBuilder.java

@@ -2504,7 +2504,7 @@ public StrBuilder minimizeCapacity() {
      *
      * @param readable  object to read from.
      * @return The number of characters read.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException Thrown if an I/O error occurs.
      * @since 3.4
      * @see #appendTo(Appendable)
      */

src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java

@@ -88,7 +88,7 @@ public final String translate(final CharSequence input) {
      * @param index int representing the current point of translation.
      * @param out Writer to translate the text to.
      * @return int count of code points consumed.
-     * @throws IOException if and only if the Writer produces an IOException.
+     * @throws IOException Thrown if and only if the Writer produces an IOException.
      */
     public abstract int translate(CharSequence input, int index, Writer out) throws IOException;
 
@@ -98,7 +98,7 @@ public final String translate(final CharSequence input) {
      *
      * @param input CharSequence that is being translated.
      * @param writer Writer to translate the text to.
-     * @throws IOException if and only if the Writer produces an IOException.
+     * @throws IOException Thrown if and only if the Writer produces an IOException.
      */
     @SuppressWarnings("resource") // Caller closes writer
     public final void translate(final CharSequence input, final Writer writer) throws IOException {

src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java

@@ -55,7 +55,7 @@ public final int translate(final CharSequence input, final int index, final Writ
      * @param codePoint int character input to translate.
      * @param out Writer to optionally push the translated output to.
      * @return boolean as to whether translation occurred or not.
-     * @throws IOException if and only if the Writer produces an IOException.
+     * @throws IOException Thrown if and only if the Writer produces an IOException.
      */
     public abstract boolean translate(int codePoint, Writer out) throws IOException;