class Exception

要約

全ての例外の祖先のクラスです。

目次

特異メソッド

• exception
• new

インスタンスメソッド

• backtrace
• exception
• inspect
• message
• set_backtrace
• to_s
• to_str

追加されるメソッド

• taguri
• taguri=
• to_yaml
• yaml_new
• yaml_tag_subclasses?

特異メソッド

new(error_message = nil) -> Exception[permalink][rdoc]

exception(error_message = nil) -> Exception

例外オブジェクトを生成して返します。

[PARAM] error_message:

エラーメッセージを表す文字列を指定します。このメッセージは属性 Exception#message の値になり、デフォルトの例外ハンドラで表示されます。

インスタンスメソッド

backtrace -> [String][permalink][rdoc]

バックトレース情報を返します。

デフォルトでは

• "#{sourcefile}:#{sourceline}:in `#{method}'" (メソッド内の場合)
• "#{sourcefile}:#{sourceline}" (トップレベルの場合)

という形式の String の配列です。

def methd
  raise
end

begin
  methd
rescue => e
  p e.backtrace
end

#=> ["filename.rb:2:in `methd'", "filename.rb:6"]

exception -> self[permalink][rdoc]

exception(error_message) -> Exception

引数を指定しない場合は self を返します。引数を指定した場合 自身のコピーを生成し Exception#message 属性を error_message にして返します。

Kernel.#raise は、実質的に、例外オブジェクトの exception メソッドの呼び出しです。

[PARAM] error_message:

エラーメッセージを表す文字列を指定します。

begin
 ...        # 何か処理
rescue => e
 raise e.exception("an error occurs during hogehoge process")  # 詳しいエラーメッセージ
end

inspect -> String[permalink][rdoc]

self のクラス名と message を文字列にして返します。

message -> String[permalink][rdoc]

to_s -> String

to_str -> String

エラーメッセージをあらわす文字列を返します。

begin
  1 + nil
rescue => e
  p e.message   #=>  "nil can't be coerced into Fixnum"
end

set_backtrace(errinfo) -> nil | String | [String][permalink][rdoc]

バックトレース情報に errinfo を設定し、設定されたバックトレース情報を返します。

[PARAM] errinfo:

nil、String あるいは String の配列のいずれかを指定します。

追加されるメソッド

taguri -> String[permalink][rdoc] [added by yaml/rubytypes]

自身のタグ URI を返します。

taguri=(val)[permalink][rdoc] [added by yaml/rubytypes]

自身のタグ URI を val に設定します。

[PARAM] val:

タグ URI を文字列で指定します。

to_yaml(opts = {}) -> String[permalink][rdoc] [added by yaml/rubytypes]

自身を YAML ドキュメントに変換します。

[PARAM] opts:

YAML ドキュメント出力の際のオプションを指定します。オプションの詳細は YAML::Syck::Emitter#reset を参照してください。

yaml_new(klass, tag, val)[permalink][rdoc] [added by yaml/rubytypes]

ライブラリ内部で使用します。

yaml_tag_subclasses? -> true[permalink][rdoc] [added by yaml/rubytypes]

常に true を返します。

ライブラリ内部で使用します。