replace with English javadoc

Author: marevol

src/main/java/org/codelibs/core/timer/TimeoutManager.java

@@ -27,7 +27,7 @@
 import org.codelibs.core.log.Logger;
 
 /**
- * Timerを扱うクラスです。
+ * A class that handles timers.
  *
  * @author higa
  *
@@ -37,34 +37,34 @@ public class TimeoutManager implements Runnable {
     private static final Logger logger = Logger.getLogger(TimeoutManager.class);
 
     /**
-     * シングルトンのためのインスタンスです。
+     * Instance for the singleton.
      */
     protected static final TimeoutManager instance = new TimeoutManager();
 
     /**
-     * Timerのための{@link Thread}です。
+     * {@link Thread} for the timer.
      */
     protected Thread thread;
 
     /**
-     * {@link TimeoutTask}管理用のリストです。
+     * A list for managing {@link TimeoutTask}.
      */
     protected final SLinkedList<TimeoutTask> timeoutTaskList = new SLinkedList<>();
 
     private TimeoutManager() {
     }
 
     /**
-     * シングルトン用のインスタンスを返します。
+     * Returns the instance for the singleton.
      *
-     * @return シングルトン用のインスタンス
+     * @return the instance for the singleton
      */
     public static TimeoutManager getInstance() {
         return instance;
     }
 
     /**
-     * 処理を開始します。
+     * Starts the process.
      */
     public synchronized void start() {
         if (thread == null) {
@@ -78,7 +78,7 @@ public synchronized void start() {
     }
 
     /**
-     * 処理を停止します。
+     * Stops the process.
      */
     public synchronized void stop() {
         if (thread != null) {
@@ -91,13 +91,13 @@ public synchronized void stop() {
     }
 
     /**
-     * スレッドに割り込みを行い、終了するまで待機します。
+     * Interrupts the thread and waits for it to terminate.
      *
      * @param timeoutMillis
-     *            待機する時間(ミリ秒単位)
-     * @return スレッドが終了した場合は<code>true</code>
+     *            The time to wait (in milliseconds)
+     * @return <code>true</code> if the thread has terminated
      * @throws InterruptedException
-     *             待機中に割り込まれた場合
+     *             If interrupted while waiting
      */
     public boolean stop(final long timeoutMillis) throws InterruptedException {
         final Thread t = this.thread;
@@ -116,19 +116,19 @@ public boolean stop(final long timeoutMillis) throws InterruptedException {
     }
 
     /**
-     * 管理している {@link TimeoutTask}をクリアします。
+     * Clears the managed {@link TimeoutTask}.
      */
     public synchronized void clear() {
         timeoutTaskList.clear();
     }
 
     /**
-     * {@link TimeoutTarget}を追加します。
+     * Adds a {@link TimeoutTarget}.
      *
-     * @param timeoutTarget target
-     * @param timeout timeout
-     * @param permanent permanent
-     * @return {@link TimeoutTask}
+     * @param timeoutTarget the target
+     * @param timeout the timeout duration
+     * @param permanent whether the task is permanent
+     * @return the {@link TimeoutTask}
      */
     public synchronized TimeoutTask addTimeoutTarget(final TimeoutTarget timeoutTarget, final int timeout, final boolean permanent) {
         final TimeoutTask task = new TimeoutTask(timeoutTarget, timeout, permanent);
@@ -138,9 +138,9 @@ public synchronized TimeoutTask addTimeoutTarget(final TimeoutTarget timeoutTarg
     }
 
     /**
-     * 管理している {@link TimeoutTask}の数を返します。
+     * Returns the number of managed {@link TimeoutTask}.
      *
-     * @return 管理している {@link TimeoutTask}の数
+     * @return the number of managed {@link TimeoutTask}
      */
     public synchronized int getTimeoutTaskCount() {
         return timeoutTaskList.size();
@@ -222,9 +222,9 @@ private synchronized boolean isInterrupted() {
     }
 
     /**
-     * 期限の切れた {@link TimeoutTask}のリストを返します。
+     * Returns the list of expired {@link TimeoutTask}.
      *
-     * @return 期限の切れた {@link TimeoutTask}のリスト
+     * @return the list of expired {@link TimeoutTask}
      */
     protected synchronized List<TimeoutTask> getExpiredTask() {
         final List<TimeoutTask> expiredTask = new ArrayList<>();
@@ -246,9 +246,9 @@ protected synchronized List<TimeoutTask> getExpiredTask() {
     }
 
     /**
-     * 管理しているタスクが無いなら処理を停止します。
+     * Stops the process if there are no managed tasks.
      *
-     * @return 停止したかどうか
+     * @return whether the process was stopped
      */
     protected synchronized boolean stopIfLeisure() {
         if (timeoutTaskList.isEmpty()) {

src/main/java/org/codelibs/core/timer/TimeoutTarget.java

@@ -16,7 +16,7 @@
 package org.codelibs.core.timer;
 
 /**
- * タイムアウトを処理するインターフェースです。
+ * This is an interface for handling timeouts.
  *
  * @author higa
  *
@@ -25,7 +25,7 @@
 public interface TimeoutTarget {
 
     /**
-     * タイムアウトの処理を記述します。
+     * Describes the processing for a timeout.
      */
     void expired();
 }

src/main/java/org/codelibs/core/timer/TimeoutTask.java

@@ -18,7 +18,7 @@
 import org.codelibs.core.exception.ClIllegalStateException;
 
 /**
- * タイムアウトを管理するクラスです。
+ * This class manages timeouts.
  *
  * @author higa
  *
@@ -49,50 +49,50 @@ public class TimeoutTask {
     }
 
     /**
-     * 期限切れかどうかを返します。
+     * Returns whether the task has expired.
      *
-     * @return 期限切れかどうか
+     * @return whether the task has expired
      */
     public boolean isExpired() {
         return System.currentTimeMillis() >= startTime + timeoutMillis;
     }
 
     /**
-     * 永続的かどうかを返します。
+     * Returns whether the task is permanent.
      *
-     * @return 永続的かどうか
+     * @return whether the task is permanent
      */
     public boolean isPermanent() {
         return permanent;
     }
 
     /**
-     * キャンセルされているかどうかを返します。
+     * Returns whether the task has been canceled.
      *
-     * @return キャンセルされているか
+     * @return whether the task has been canceled
      */
     public boolean isCanceled() {
         return status == CANCELED;
     }
 
     /**
-     * キャンセルします。
+     * Cancels the task.
      */
     public void cancel() {
         status = CANCELED;
     }
 
     /**
-     * 止まっているかどうか返します。
+     * Returns whether the task is stopped.
      *
-     * @return 止まっているかどうか
+     * @return whether the task is stopped
      */
     public boolean isStopped() {
         return status == STOPPED;
     }
 
     /**
-     * タイマーをとめます。
+     * Stops the timer.
      */
     public void stop() {
         if (status != ACTIVE) {
@@ -102,7 +102,7 @@ public void stop() {
     }
 
     /**
-     * タイマーを再開始します。
+     * Restarts the timer.
      */
     public void restart() {
         status = ACTIVE;

src/main/java/org/codelibs/core/xml/DocumentBuilderFactoryUtil.java

@@ -24,7 +24,7 @@
 import org.codelibs.core.log.Logger;
 
 /**
- * {@link DocumentBuilderFactory}の用のユーティリティクラスです。
+ * Utility class for {@link DocumentBuilderFactory}.
  *
  * @author higa
  */
@@ -33,9 +33,9 @@ public abstract class DocumentBuilderFactoryUtil {
     private static final Logger logger = Logger.getLogger(DocumentBuilderFactoryUtil.class);
 
     /**
-     * 新しい {@link DocumentBuilderFactory}のインスタンスを返します。
+     * Returns a new instance of {@link DocumentBuilderFactory}.
      *
-     * @return 新しい {@link DocumentBuilderFactory}のインスタンス
+     * @return A new instance of {@link DocumentBuilderFactory}.
      */
     public static DocumentBuilderFactory newInstance() {
         return newInstance(false);
@@ -62,9 +62,9 @@ public static DocumentBuilderFactory newInstance(final boolean external) {
     }
 
     /**
-     * 新しい {@link DocumentBuilder}を作成します。
+     * Creates a new {@link DocumentBuilder}.
      *
-     * @return 新しい {@link DocumentBuilder}
+     * @return A new {@link DocumentBuilder}.
      */
     public static DocumentBuilder newDocumentBuilder() {
         try {

src/main/java/org/codelibs/core/xml/DocumentBuilderUtil.java

@@ -28,19 +28,19 @@
 import org.xml.sax.SAXException;
 
 /**
- * {@link DocumentBuilder}用のユーティリティクラスです。
+ * Utility class for {@link DocumentBuilder}.
  *
  * @author higa
  */
 public abstract class DocumentBuilderUtil {
 
     /**
-     * XMLを解析します。
+     * Parses the XML.
      *
      * @param builder
-     *            {@link DocumentBuilder}。{@literal null}であってはいけません
+     *            {@link DocumentBuilder}; must not be {@literal null}.
      * @param is
-     *            入力ストリーム。{@literal null}であってはいけません
+     *            Input stream; must not be {@literal null}.
      * @return {@link Document}
      */
     public static Document parse(final DocumentBuilder builder, final InputStream is) {