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

   1 /*
   2  * PMD english information handler
   3  *
   4  * License : The MIT License
   5  * Copyright(c) 2010 MikuToga Partners
   6  */
   7
   8 package jp.sfjp.mikutoga.pmd.parser;
   9
  10 import jp.sfjp.mikutoga.bin.parser.LoopHandler;
  11 import jp.sfjp.mikutoga.bin.parser.MmdFormatException;
  12 import jp.sfjp.mikutoga.bin.parser.ParseStage;
  13
  14 /**
  15  * PMDモデルの英語情報の通知用ハンドラ。
  16  */
  17 public interface PmdEngHandler extends LoopHandler {
  18
  19     /** ボーン英語名抽出ループ。 */
  20     public static final ParseStage ENGBONE_LIST = new ParseStage();
  21
  22     /** モーフ英語名抽出ループ。 */
  23     public static final ParseStage ENGMORPH_LIST = new ParseStage();
  24
  25     /** ボーングループ英語名抽出ループ。 */
  26     public static final ParseStage ENGBONEGROUP_LIST = new ParseStage();
  27
  28     /**
  29      * PMD英語情報の有無の通知を受け取る。
  30      * @param hasEnglishInfo 英語情報が含まれればtrue
  31      * @throws MmdFormatException 不正フォーマットによる
  32      * パース処理の中断をパーサに指示
  33      */
  34     public abstract void pmdEngEnabled(boolean hasEnglishInfo)
  35             throws MmdFormatException;
  36
  37     /**
  38      * PMD英語基本情報の通知を受け取る。
  39      * @param modelName モデル名
  40      * @param description モデルの説明文。改行CRLFは"\n"に変換される。
  41      * @throws MmdFormatException 不正フォーマットによる
  42      * パース処理の中断をパーサに指示
  43      */
  44     public abstract void pmdEngModelInfo(String modelName, String description)
  45             throws MmdFormatException;
  46
  47     /**
  48      * 英語ボーン名の通知を受け取る。
  49      *
  50      * <p>{@link #ENGBONE_LIST}ループの構成要素
  51      *
  52      * @param boneName 英語ボーン名
  53      * @throws MmdFormatException 不正フォーマットによる
  54      * パース処理の中断をパーサに指示
  55      */
  56     public abstract void pmdEngBoneInfo(String boneName)
  57             throws MmdFormatException;
  58
  59     /**
  60      * 英語モーフ名の通知を受け取る。
  61      * 特殊モーフ名「base」に対応する英語名は通知されない。
  62      *
  63      * <p>{@link #ENGMORPH_LIST}ループの構成要素
  64      *
  65      * @param morphName 英語モーフ名
  66      * @throws MmdFormatException 不正フォーマットによる
  67      * パース処理の中断をパーサに指示
  68      */
  69     public abstract void pmdEngMorphInfo(String morphName)
  70             throws MmdFormatException;
  71
  72     /**
  73      * 英語ボーングループ名の通知を受け取る。
  74      *
  75      * <p>{@link #ENGBONEGROUP_LIST}ループの構成要素
  76      *
  77      * @param groupName 英語ボーングループ名
  78      * @throws MmdFormatException 不正フォーマットによる
  79      * パース処理の中断をパーサに指示
  80      */
  81     public abstract void pmdEngBoneGroupInfo(String groupName)
  82             throws MmdFormatException;
  83
  84 }