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

   1 /*\r
   2  * PMD english 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.LoopHandler;\r
  11 import jp.sourceforge.mikutoga.parser.MmdFormatException;\r
  12 import jp.sourceforge.mikutoga.parser.ParseStage;\r
  13 \r
  14 /**\r
  15  * PMDモデルの英語情報の通知用ハンドラ。\r
  16  */\r
  17 public interface PmdEngHandler extends LoopHandler {\r
  18 \r
  19     /**\r
  20      * 英語情報パースステージ。\r
  21      */\r
  22     class PmdEngStage extends ParseStage{\r
  23         /** コンストラクタ。 */\r
  24         PmdEngStage(){ super(); return; }\r
  25     }\r
  26 \r
  27     /** ボーン英語名抽出ループ。 */\r
  28     ParseStage ENGBONE_LIST = new PmdEngStage();\r
  29 \r
  30     /** モーフ英語名抽出ループ。 */\r
  31     ParseStage ENGMORPH_LIST = new PmdEngStage();\r
  32 \r
  33     /** ボーングループ英語名抽出グループ。 */\r
  34     ParseStage ENGBONEGROUP_LIST = new PmdEngStage();\r
  35 \r
  36     /**\r
  37      * PMD英語情報の有無の通知を受け取る。\r
  38      * @param hasEnglishInfo 英語情報が含まれればtrue\r
  39      * @throws MmdFormatException 不正フォーマットによる\r
  40      * パース処理の中断をパーサに指示\r
  41      */\r
  42     void pmdEngEnabled(boolean hasEnglishInfo) 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 pmdEngModelInfo(String modelName, String description)\r
  52             throws MmdFormatException;\r
  53 \r
  54     /**\r
  55      * 英語ボーン名の通知を受け取る。\r
  56      * {@link #ENGBONE_LIST}ループの構成要素\r
  57      * @param boneName 英語ボーン名\r
  58      * @throws MmdFormatException 不正フォーマットによる\r
  59      * パース処理の中断をパーサに指示\r
  60      */\r
  61     void pmdEngBoneInfo(String boneName) throws MmdFormatException;\r
  62 \r
  63     /**\r
  64      * 英語モーフ名の通知を受け取る。\r
  65      * モーフ名「base」に対応する英語名は通知されない。\r
  66      * {@link #ENGMORPH_LIST}ループの構成要素\r
  67      * @param morphName 英語モーフ名\r
  68      * @throws MmdFormatException 不正フォーマットによる\r
  69      * パース処理の中断をパーサに指示\r
  70      */\r
  71     void pmdEngMorphInfo(String morphName) throws MmdFormatException;\r
  72 \r
  73     /**\r
  74      * 英語ボーングループ名の通知を受け取る。\r
  75      * {@link #ENGBONEGROUP_LIST}ループの構成要素\r
  76      * @param groupName 英語ボーングループ名\r
  77      * @throws MmdFormatException 不正フォーマットによる\r
  78      * パース処理の中断をパーサに指示\r
  79      */\r
  80     void pmdEngBoneGroupInfo(String groupName) throws MmdFormatException;\r
  81 \r
  82 }\r