Ruby 1.9.0 リファレンスマニュアル > ライブラリ一覧 > getoptlongライブラリ > GetoptLongクラス

class GetoptLong

クラスの継承リスト: GetoptLong < Object < Kernel < BasicObject

要約

特異メソッド

定義 説明
new
new(option...)

GetoptLong のオブジェクトを生成します。option が与えられる たときは、それを set_options メソッドに渡します。

インスタンスメソッド

定義 説明
each {|optname, optarg|...}
each_option {|optname, optarg|...}

get メソッドのイテレータ版です。オプションとその引数の取得を 繰り返し行います。詳しくは get の説明を参照して下さい。

error
error?

現在のエラーの型を返します。エラーが発生していなければ、nil を返します。

error_message

現在のエラーのエラーメッセージを返します。エラーが発生していな ければ、nil を返します。

get
get_option

ARGV から、次のオプションの名前と、もしあればその引数の組を取 得します。メソッドは 2 つの値を返し、1 つ目の値がオプション名 (例: --max-size) で、2 つ目がオプションの引数 (例: 20K) で す。get の通常の呼び出し方は次の通りです。

ordering

現在の順序形式を返します。

ordering=(ordering)

順序形式 (ordering) を設定します。引数 ordering は、 PERMUTE, REQUIRE_ORDER, RETURN_IN_ORDER のいずれかでなく てはなりません。それ以外の値を代入しようとすると、例外 ArgumentError が発生します。

quiet
quiet?

静粛モードが有効であれば、TRUE が返ります。そうでなければ、 FALSE が返ります。

quiet=(flag)

flag が TRUE なら、静粛 (quiet) モードが有効になります。 静粛モードが有効になっていると、レシーバのオブジェクトは、 get, get_option, each, each_option メソッドでエラーが 発生しても、エラーメッセージを出力しません。初期値は、FALSE になっています。

set_options(option...)

あなたのプログラムで、認識させたいオプションをセットします。 個々の option は、オプション名と引数のフラグからなる配列でな ければいけません。

terminate

オプションの処理を、強制的に終了させます。ただし、エラーが起き ている状態でこのメソッドを起動しても、終了させることはできませ ん。エラーが起きている状態でこのメソッドを起動すると、 RuntimeError 例外が発生します。すでにオプションの処理が終了 しているときは、このメソッドは何も行いません。

terminated?

エラーが起きずにオプションの処理が終了しているときは TRUE が 返ります。それ以外のときは、FALSE が返ります。

定数

定義 説明
NO_ARGUMENT
REQUIRED_ARGUMENT
OPTIONAL_ARGUMENT

オプションへの引数のフラグです。

PERMUTE
REQUIRE_ORDER
RETURN_IN_ORDER

順序形式を表しています。

継承したメソッド

! != == === =~ __id__ __send__ _dump class clone dclone display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? marshal_dump marshal_load method method_missing methods nil? pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods public_methods remove_instance_variable respond_to? singleton_method_added singleton_method_removed singleton_method_undefined singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_splat to_str to_yaml to_yaml_properties to_yaml_style untaint