001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.system;
017
018/**
019 * 主に文字のエンコード・エラーやデコード・エラーが発生したときにスローされるエクセプションクラスです。
020 *
021 * OgRuntimeException を継承しているため、try{} catch() {} は不要です。
022 * このエクセプションクラスは、java.nio.charset.CharacterCodingException が発生したときに、
023 * こちらのExceptionに変換して、再 throw するケースがほとんどです。
024 * TableReader系で、AutoReader を使用する場合、複数のエンコードでチャレンジするため、
025 * 一般のエラーと、エンコードエラーを分けて捕らえたいのが目的です。
026 * 機能的には、拡張されていません。
027 *
028 * @og.group エラー処理
029 * @og.rev 6.5.0.1 (2016/10/21) 新規追加
030 *
031 * @version  6.5
032 * @author   Kazuhiko Hasegawa
033 * @since    JDK8.0,
034 */
035public class OgCharacterException extends OgRuntimeException {
036        private static final long serialVersionUID = 650120161014L ;
037
038        /**
039         * 詳細メッセージを指定しないで OgCharacterException を構築します。
040         *
041         * @og.rev 6.5.0.1 (2016/10/21) 新規追加
042         *
043         * @see         org.opengion.fukurou.system.OgRuntimeException#OgRuntimeException()
044         */
045        public OgCharacterException() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
046
047        /**
048         *  指定された詳細メッセージを持つ OgCharacterException を構築します。
049         *
050         * @og.rev 6.5.0.1 (2016/10/21) 新規追加
051         *
052         * @param       msg     詳細メッセージ
053         * @see         org.opengion.fukurou.system.OgRuntimeException#OgRuntimeException(String)
054         */
055        public OgCharacterException( final String msg ) {
056                super( msg );
057        }
058
059        /**
060         *  指定された詳細メッセージを持つ OgCharacterException を構築します。
061         *
062         * @og.rev 6.5.0.1 (2016/10/21) 新規追加
063         *
064         * @param       th      例外Throwableオブジェクト
065         * @see         org.opengion.fukurou.system.OgRuntimeException#OgRuntimeException(Throwable)
066         */
067        public OgCharacterException( final Throwable th ) {
068                super( th );
069        }
070
071        /**
072         *  指定されたオブジェクトを受け取る OgCharacterException を構築します。
073         *
074         * @og.rev 6.5.0.1 (2016/10/21) 新規追加
075         *
076         * @param       msg     詳細メッセージ
077         * @param       th      例外Throwableオブジェクト
078         * @see         org.opengion.fukurou.system.OgRuntimeException#OgRuntimeException(String,Throwable)
079         */
080        public OgCharacterException( final String msg,final Throwable th ) {
081                super( msg,th );
082        }
083}