/*
 * StringConvertException class.
 *
 * Copyright (C) 2007 SATOH Takayuki All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package ts.util.text;

/**
 * 文字列の変更が完了しなかった場合にスローされる例外クラス。
 *
 * @author  佐藤隆之. 
 * @version $Revision: 1.1.1.1 $, $Date: 2010-10-16 00:03:53 $
 */
public class StringConvertException extends Exception
{
  /* シリアル番号。 */
  static final long serialVersionUID = 1584378524238190509L;

  /** 変更が中断されたインデックス。 */
  private int stoppedIndex_ = 0;

  /** 中断されるまで変更された文字列。 */
  private String convertedString_ = "";

  /**
   * 変更が中断されたインデックスと、中断されるまで変換された文字列を引数に
   * とるコンストラクタ。
   * <br>
   * なお、ここでいうインデックスとは、コード・ポイント単位の値である。
   *
   * @param  index  変更が中断されたインデックス。
   * @param  converted  中断されるまで変換された文字列。
   */
  public StringConvertException(int index, CharSequence converted)
  {
    stoppedIndex_ = index;
    convertedString_ = (converted == null) ? null : converted.toString();
  }

  /**
   * 変更が中断されたインデックスと、中断されるまで変換された文字列と、
   * 例外メッセージを引数にとるコンストラクタ。
   * <br>
   * なお、ここでいうインデックスとは、コード・ポイント単位の値である。
   *
   * @param  index  変更が中断されたインデックス。
   * @param  converted  中断されるまで変換された文字列。
   * @param  msg 例外メッセージ。
   */
  public StringConvertException(int index, CharSequence converted, String msg)
  {
    super(msg);

    stoppedIndex_ = index;
    convertedString_ = (converted == null) ? null : converted.toString();
  }

  /**
   * 変更が中断されたインデックスを取得する。
   * <br>
   * なお、ここでいうインデックスとは、コード・ポイント単位の値である。
   *
   * @return 変更が中断されたインデックス。
   */
  public int getStoppedIndex()
  {
    return stoppedIndex_ ;
  }

  /**
   * 中断されるまで変換された文字列を取得する。
   *
   * @return 中断されるまで変換された文字列。
   */
  public String convertedString()
  {
    return convertedString_ ;
  }
}

