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

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