/*
 * SpecialCharNotEscapedException 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:52 $
 */
public class SpecialCharNotEscapedException extends StringConvertException
{
  /** シリアル番号。 */
  static final long serialVersionUID = 7412233169296218329L;

  /** エスケープされていなかった特殊文字。 */
  private String specialChar_ ;

  /**
   * 例外が発生したインデックスと、それまでに変換された文字列、エスケープされて
   * いなかった文字を引数にとるコンストラクタ。
   * <br>
   * なお、ここでいうインデックスとは、コード・ポイント単位の値である。
   *
   * @param  index 例外が発生したインデックス。
   * @param  converted 例外が発生するまでに変換された文字列。
   * @param  specialChar エスケープされていなかった特殊文字。
   */
  public SpecialCharNotEscapedException(
    int index, CharSequence converted, String specialChar)
  {
    super(index, converted);

    assert (specialChar != null) : "@param:specialChar is null.";
    specialChar_ = specialChar;
  }

  /**
   * 例外が発生したインデックスと、それまでに変換された文字列、エスケープされて
   * いなかった文字、例外メッセージを引数にとるコンストラクタ。
   * <br>
   * なお、ここでいうインデックスとは、コード・ポイント単位の値である。
   *
   * @param  index 例外が発生したインデックス。
   * @param  converted 例外が発生するまでに変換された文字列。
   * @param  specialChar エスケープされていなかった特殊文字。
   * @param  msg 例外メッセージ。
   */
  public SpecialCharNotEscapedException(
    int index, CharSequence converted, String specialChar, String msg)
  {
    super(index, converted, msg);

    specialChar_ = specialChar;
  }

  /**
   * 例外の原因となった特殊文字を取得する。
   *
   * @return 例外の原因となった特殊文字。
   */
  public String getSpecialChar()
  {
    return specialChar_ ;
  }
}

