lib/src/jp/nyatla/nyartoolkit/NyARException.java

   1 /* \r
   2  * PROJECT: NyARToolkit\r
   3  * --------------------------------------------------------------------------------\r
   4  * This work is based on the original ARToolKit developed by\r
   5  *   Hirokazu Kato\r
   6  *   Mark Billinghurst\r
   7  *   HITLab, University of Washington, Seattle\r
   8  * http://www.hitl.washington.edu/artoolkit/\r
   9  *\r
  10  * The NyARToolkit is Java edition ARToolKit class library.\r
  11  * Copyright (C)2008-2009 Ryo Iizuka\r
  12  *\r
  13  * This program is free software: you can redistribute it and/or modify\r
  14  * it under the terms of the GNU General Public License as published by\r
  15  * the Free Software Foundation, either version 3 of the License, or\r
  16  * (at your option) any later version.\r
  17  * \r
  18  * This program is distributed in the hope that it will be useful,\r
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  21  * GNU General Public License for more details.\r
  22  *\r
  23  * You should have received a copy of the GNU General Public License\r
  24  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  25  * \r
  26  * For further information please contact.\r
  27  *      http://nyatla.jp/nyatoolkit/\r
  28  *      <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>\r
  29  * \r
  30  */\r
  31 package jp.nyatla.nyartoolkit;\r
  32 \r
  33 /**\r
  34  * NyARToolkitライブラリが生成するExceptionのクラスです。\r
  35  * このクラスは、NyARToolkitライブラリでのみ使用します。\r
  36  */\r
  37 public class NyARException extends Exception\r
  38 {\r
  39         private static final long serialVersionUID = 1L;\r
  40 \r
  41         /**\r
  42          * コンストラクタです。\r
  43          * 例外オブジェクトを生成します。\r
  44          */\r
  45         public NyARException()\r
  46         {\r
  47                 super();\r
  48         }\r
  49         /**\r
  50          * コンストラクタです。\r
  51          * 例外オブジェクト継承して、例外を生成します。\r
  52          * @param e\r
  53          * 継承する例外オブジェクト\r
  54          */\r
  55         public NyARException(Exception e)\r
  56         {\r
  57                 super(e);\r
  58         }\r
  59         /**\r
  60          * コンストラクタです。\r
  61          * メッセージを指定して、例外を生成します。\r
  62          * @param m\r
  63          */\r
  64         public NyARException(String m)\r
  65         {\r
  66                 super(m);\r
  67         }\r
  68         /**\r
  69          * ライブラリ開発者向けの関数です。\r
  70          * 意図的に例外を発生するときに、コードに埋め込みます。\r
  71          * @param m\r
  72          * 例外メッセージを指定します。\r
  73          * @throws NyARException\r
  74          */\r
  75         public static void trap(String m) throws NyARException\r
  76         {\r
  77                 throw new NyARException("トラップ:" + m);\r
  78         }\r
  79         /**\r
  80          * ライブラリ開発者向けの関数です。\r
  81          * "Not Implement!"メッセージを指定して、例外をスローします。\r
  82          * この関数は、NyARToolkitの未実装部分に埋め込みます。\r
  83          * @throws NyARException\r
  84          */\r
  85         public static void notImplement() throws NyARException\r
  86         {\r
  87                 throw new NyARException("Not Implement!");\r
  88         }\r
  89         /**\r
  90          * ライブラリ開発者向けの関数です。\r
  91          * 関数が使用不能である事を、例外で通知します。\r
  92          * @throws NyARException\r
  93          */\r
  94         public static void unavailability() throws NyARException\r
  95         {\r
  96                 throw new NyARException("unavailability!");\r
  97         }\r
  98 }\r