src/main/java/jp/sourceforge/jindolf/FaceIconSet.java

   1 /*\r
   2  * Face icon set\r
   3  *\r
   4  * License : The MIT License\r
   5  * Copyright(c) 2009 olyutorskii\r
   6  */\r
   7 \r
   8 package jp.sourceforge.jindolf;\r
   9 \r
  10 import java.util.HashMap;\r
  11 import java.util.Map;\r
  12 \r
  13 /**\r
  14  * 顔アイコンWiki表記のセット。\r
  15  */\r
  16 public class FaceIconSet{\r
  17 \r
  18     private final String caption;\r
  19     private final String author;\r
  20     private final String urlText;\r
  21     private final Map<Avatar, String> wikiMap = new HashMap<Avatar, String>();\r
  22 \r
  23     /**\r
  24      * コンストラクタ。\r
  25      * @param caption 説明\r
  26      * @param author 作者\r
  27      * @param urlText URL文字列\r
  28      */\r
  29     public FaceIconSet(String caption, String author, String urlText){\r
  30         super();\r
  31         this.caption = caption;\r
  32         this.author = author;\r
  33         this.urlText = urlText;\r
  34         return;\r
  35     }\r
  36 \r
  37     /**\r
  38      * 説明文字列を得る。\r
  39      * @return 説明文字列\r
  40      */\r
  41     public String getCaption(){\r
  42         return this.caption;\r
  43     }\r
  44 \r
  45     /**\r
  46      * 作者名を得る。\r
  47      * @return 作者名\r
  48      */\r
  49     public String getAuthor(){\r
  50         return this.author;\r
  51     }\r
  52 \r
  53     /**\r
  54      * URL文字列を得る。\r
  55      * @return URL文字列\r
  56      */\r
  57     public String getUrlText(){\r
  58         return this.urlText;\r
  59     }\r
  60 \r
  61     /**\r
  62      * Avatarに対するWiki表記を登録する。\r
  63      * @param avatar Avatar\r
  64      * @param wiki Wiki表記\r
  65      */\r
  66     public void registIconWiki(Avatar avatar, String wiki){\r
  67         this.wikiMap.put(avatar, wiki);\r
  68         return;\r
  69     }\r
  70 \r
  71     /**\r
  72      * Avatarに対するWiki表記を取得する。\r
  73      * @param avatar Avatar\r
  74      * @return Wiki表記\r
  75      */\r
  76     public String getAvatarIconWiki(Avatar avatar){\r
  77         String wiki = this.wikiMap.get(avatar);\r
  78         return wiki;\r
  79     }\r
  80 \r
  81     /**\r
  82      * アイコンセットの文字列化。\r
  83      * コンボボックスアイテムの表記などで使われることを想定。\r
  84      * @return 文字列\r
  85      */\r
  86     @Override\r
  87     public String toString(){\r
  88         return getCaption();\r
  89     }\r
  90 \r
  91 }\r