Ruby 1.9.3 リファレンスマニュアル > ライブラリ一覧 > optparseライブラリ > OptionParser::ParseErrorクラス

class OptionParser::ParseError + StandardError + Exception

クラスの継承リスト: OptionParser::ParseError < StandardError < Exception < Object < Kernel < BasicObject

要約

OptionParser の例外クラスの基底クラスです。

new(error_message = nil) -> Exception

exception(error_message = nil) -> Exception

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

[PARAM] error_message:

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

filter_backtrace(array) -> [String]

array で指定されたバックトレースから optparse ライブラリに関する行を除 外します。

デバッグモード($DEBUGが真)の場合は何もしません。

[PARAM] array:

バックトレースを文字列の配列で指定します。

[RETURN]

array を返します。

self == other -> bool

自身と指定された other のクラスが同じであり、message と backtrace が == メソッドで比較して 等しい場合に true を返します。そうでない場合に false を返します。

[PARAM] other:

自身と比較したいオブジェクトを指定します。

args -> Array

エラーのあったオプションの一覧を配列で返します。

[RETURN]

エラーのあったオプションの一覧。

backtrace -> [String]

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

デフォルトでは

• "#{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

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

自身を人間が読みやすい形の文字列表現にして返します。

[RETURN]

文字列を返します。

[SEE_ALSO] Object#inspect

message -> String

to_s -> String

標準エラーに出力するメッセージを返します。

[RETURN]

文字列を返します。

message -> String

to_s -> String

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

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

reason -> String

エラーの内容を文字列で返します。

[RETURN]

文字列を返します。

reason=(reason)

エラーの内容を指定します。

[PARAM] reason:

文字列を指定します。

recover(argv) -> Array

argv の先頭に self.args を戻します。

argv を返します。

[PARAM] argv:

OptionParser#parse に渡したオブジェクトなどの配列を指定します。

[RETURN]

argv を返します。

set_backtrace(array) -> [String]

自身に array で指定したバックトレースを設定します。

[PARAM] array:

バックトレースを文字列の配列で指定します。

[RETURN]

array を返します。

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

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

[PARAM] errinfo:

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

set_option(opt, eq) -> self

エラーのあったオプションを指定します。

eq が真の場合、self が管理するエラーのあったオプションの一覧の先頭を opt で置き換えます。そうでない場合は先頭に opt を追加します。

[PARAM] opt:

エラーのあったオプションを指定します。

[PARAM] eq:

self が管理するエラーのあったオプションの一覧の先頭を置き換え るかどうかを指定します。

[RETURN]

self を返します。