src/main/java/jp/sourceforge/mikutoga/parser/pmd/PmdBasicHandler.java

   1 /*\r
   2  * PMD basic information handler\r
   3  *\r
   4  * License : The MIT License\r
   5  * Copyright(c) 2010 MikuToga Partners\r
   6  */\r
   7 \r
   8 package jp.sourceforge.mikutoga.parser.pmd;\r
   9 \r
  10 import jp.sourceforge.mikutoga.parser.MmdFormatException;\r
  11 \r
  12 /**\r
  13  * PMDモデル情報ファイルの基本情報の通知用ハンドラ。\r
  14  */\r
  15 public interface PmdBasicHandler {\r
  16 \r
  17     /**\r
  18      * PMDファイルのパース処理開始の通知を受け取る。\r
  19      * @throws MmdFormatException 不正フォーマットによる\r
  20      * パース処理の中断をパーサに指示\r
  21      */\r
  22     void pmdParseStart()\r
  23             throws MmdFormatException;\r
  24 \r
  25     /**\r
  26      * PMDファイルのパース処理終了の通知を受け取る。\r
  27      * @param hasMoreData 入力ソースに\r
  28      * まだ読み込まれていないデータがあればtrue\r
  29      * @throws MmdFormatException 不正フォーマットによる\r
  30      * パース処理の中断をパーサに指示\r
  31      */\r
  32     void pmdParseEnd(boolean hasMoreData)\r
  33             throws MmdFormatException;\r
  34 \r
  35     /**\r
  36      * PMDファイルのヘッダ情報の通知を受け取る。\r
  37      * @param ver ヘッダ情報の版数。\r
  38      * @throws MmdFormatException 不正フォーマットによる\r
  39      * パース処理の中断をパーサに指示\r
  40      */\r
  41     void pmdHeaderInfo(float ver)\r
  42             throws MmdFormatException;\r
  43 \r
  44     /**\r
  45      * PMDファイルのモデル基本情報の通知を受け取る。\r
  46      * @param modelName モデル名\r
  47      * @param description モデルの説明文。改行CRLFは"\n"に変換される。\r
  48      * @throws MmdFormatException 不正フォーマットによる\r
  49      * パース処理の中断をパーサに指示\r
  50      */\r
  51     void pmdModelInfo(String modelName, String description)\r
  52             throws MmdFormatException;\r
  53 \r
  54 }\r