Class List
In: lib/optparse.rb
Parent: Object

Simple option list providing mapping from short and/or long option string to OptionParser::Switch and mapping from acceptable argument to matching pattern and converter pair. Also provides summary feature.

Methods

accept   append   complete   each_option   new   prepend   reject   search   summarize  

Attributes

atype  [R]  Map from acceptable argument types to pattern and converter pairs.
list  [R]  List of all switches and summary string.
long  [R]  Map from long style option switches to actual switch objects.
short  [R]  Map from short style option switches to actual switch objects.

Public Class methods

new()

Just initializes all instance variables.

Public Instance methods

accept(t, pat = /.*/nm, &block)

See OptionParser.accept.

append(*args)

Appends switch at the tail of the list, and associates short, long and negated long options. Arguments are:

switch:OptionParser::Switch instance to be inserted.
short_opts:List of short style options.
long_opts:List of long style options.
nolong_opts:List of long style options with "no-" prefix. 
  append(switch, short_opts, long_opts, nolong_opts)
complete(id, opt, icase = false, *pat, &block)

Searches list id for opt and the optional patterns for completion pat. If icase is true, the search is case insensitive. The result is returned or yielded if a block is given. If it isn‘t found, nil is returned.

each_option(&block)

Iterates over each option, passing the option to the block.

prepend(*args)

Inserts switch at the head of the list, and associates short, long and negated long options. Arguments are:

switch:OptionParser::Switch instance to be inserted.
short_opts:List of short style options.
long_opts:List of long style options.
nolong_opts:List of long style options with "no-" prefix. 
  prepend(switch, short_opts, long_opts, nolong_opts)
reject(t)

See OptionParser.reject.

search(id, key) {|val| ...}

Searches key in id list. The result is returned or yielded if a block is given. If it isn‘t found, nil is returned.

summarize(*args, &block)

Creates the summary table, passing each line to the block (without newline). The arguments args are passed along to the summarize method which is called on every option.

[Validate]

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.