Merge commit '2234b50cfbe7c86237086a3bf4e62397814a390e'

[jindolf/JinParser.git] / src / main / java / jp / sourceforge / jindolf / parser / DecodeHandler.java

diff --git a/src/main/java/jp/sourceforge/jindolf/parser/DecodeHandler.java b/src/main/java/jp/sourceforge/jindolf/parser/DecodeHandler.java
index 2496eb7..41c3206 100644 (file)
--- a/src/main/java/jp/sourceforge/jindolf/parser/DecodeHandler.java
+++ b/src/main/java/jp/sourceforge/jindolf/parser/DecodeHandler.java
@@ -1,64 +1,64 @@
-/*\r
- * decode handler\r
- *\r
- * Copyright(c) 2009 olyutorskii\r
- * $Id: DecodeHandler.java 894 2009-11-04 07:26:59Z olyutorskii $\r
- */\r
-\r
-package jp.sourceforge.jindolf.parser;\r
-\r
-import java.nio.charset.CharsetDecoder;\r
-\r
-/**\r
- * 文字デコードハンドラ。\r
- * {@link StreamDecoder}により呼ばれる。\r
- * メソッドが呼ばれる順番は\r
- * {@link #startDecoding}が最初で\r
- * {@link #endDecoding}が最後。\r
- * その間、{@link #charContent}\r
- * または{@link #decodingError}が複数回呼ばれる。\r
- * 各メソッドは、{@link DecodeException}をスローすることで\r
- * デコード処理を中止させることができる。\r
- */\r
-public interface DecodeHandler{\r
-\r
-    /**\r
-     * デコード開始の通知を受け取る。\r
-     * @param decoder デコーダ\r
-     * @throws DecodeException デコードエラー\r
-     */\r
-    void startDecoding(CharsetDecoder decoder)\r
-            throws DecodeException;\r
-\r
-    /**\r
-     * 正常にデコードした文字列の通知を受け取る。\r
-     * seqの内容は、ハンドラ呼び出し元で随時変更されうる。\r
-     * seqの内容を後々再利用するつもりなら、\r
-     * 制御を呼び出し元に戻すまでの間に必要な箇所をコピーする必要がある。\r
-     * @param seq 文字列\r
-     * @throws DecodeException デコードエラー\r
-     */\r
-    void charContent(CharSequence seq)\r
-            throws DecodeException;\r
-\r
-    /**\r
-     * デコードエラーの通知を受け取る。\r
-     * errorArrayの内容は、ハンドラ呼び出し元で随時変更されうる。\r
-     * errorArrayの内容を後々再利用するつもりなら、\r
-     * 制御を呼び出し元に戻すまでの間に必要な箇所をコピーする必要がある。\r
-     * @param errorArray エラーを引き起こした入力バイトシーケンス。\r
-     * @param offset errorArrayに含まれるエラーの開始位置。\r
-     * @param length errorArrayに含まれるエラーのバイト長。\r
-     * @throws DecodeException デコードエラー\r
-     */\r
-    void decodingError(byte[] errorArray, int offset, int length)\r
-            throws DecodeException;\r
-\r
-    /**\r
-     * デコード終了の通知を受け取る。\r
-     * @throws DecodeException デコードエラー\r
-     */\r
-    void endDecoding()\r
-            throws DecodeException;\r
-\r
-}\r
+/*
+ * decode handler
+ *
+ * License : The MIT License
+ * Copyright(c) 2009 olyutorskii
+ */
+
+package jp.sourceforge.jindolf.parser;
+
+import java.nio.charset.CharsetDecoder;
+
+/**
+ * 文字デコードハンドラ。
+ * {@link StreamDecoder}により呼ばれる。
+ * メソッドが呼ばれる順番は
+ * {@link #startDecoding}が最初で
+ * {@link #endDecoding}が最後。
+ * その間、{@link #charContent}
+ * または{@link #decodingError}が複数回呼ばれる。
+ * 各メソッドは、{@link DecodeException}をスローすることで
+ * デコード処理を中止させることができる。
+ */
+public interface DecodeHandler{
+
+    /**
+     * デコード開始の通知を受け取る。
+     * @param decoder デコーダ
+     * @throws DecodeException デコードエラー
+     */
+    void startDecoding(CharsetDecoder decoder)
+            throws DecodeException;
+
+    /**
+     * 正常にデコードした文字列の通知を受け取る。
+     * seqの内容は、ハンドラ呼び出し元で随時変更されうる。
+     * seqの内容を後々再利用するつもりなら、
+     * 制御を呼び出し元に戻すまでの間に必要な箇所をコピーする必要がある。
+     * @param seq 文字列
+     * @throws DecodeException デコードエラー
+     */
+    void charContent(CharSequence seq)
+            throws DecodeException;
+
+    /**
+     * デコードエラーの通知を受け取る。
+     * errorArrayの内容は、ハンドラ呼び出し元で随時変更されうる。
+     * errorArrayの内容を後々再利用するつもりなら、
+     * 制御を呼び出し元に戻すまでの間に必要な箇所をコピーする必要がある。
+     * @param errorArray エラーを引き起こした入力バイトシーケンス。
+     * @param offset errorArrayに含まれるエラーの開始位置。
+     * @param length errorArrayに含まれるエラーのバイト長。
+     * @throws DecodeException デコードエラー
+     */
+    void decodingError(byte[] errorArray, int offset, int length)
+            throws DecodeException;
+
+    /**
+     * デコード終了の通知を受け取る。
+     * @throws DecodeException デコードエラー
+     */
+    void endDecoding()
+            throws DecodeException;
+
+}