Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > observerライブラリ > Observableモジュール

module Observable

クラスの継承リスト: Observable

要約

Observer パターンを提供するモジュールです。

Mix-in により Observer パターンを提供します。

Observable モジュールを include したクラスは Observable#changed メソッドにより更新フラグを立て、 Observable#notify_observers が呼び出されると 更新フラグが立っている場合はオブザーバに通知します (オブザーバの update メソッドを呼び出す)。 Observable#notify_observers の引数は そのままオブザーバの update メソッドに渡されます。

サンプルコード

require 'observer'
class AObservable
  include Observable
  ...
end
class AObserver
  def update(arg)
    ...
  end
  ...
end
obj = AObservable.new
observer = AObserver.new
obj.add_observer(observer)
obj.changed
obj.notify_observers(args)

目次

インスタンスメソッド

add_observer changed changed? count_observers delete_observer delete_observers notify_observers

インスタンスメソッド

add_observer(observer, func=:update) -> Array[permalink][rdoc]

オブザーバを登録します。

オブザーバを登録し、登録されているオブザーバのリストを返します。

オブザーバは update メソッドを備えている必要があります。

observer が update メソッドを持たないときは 例外 NoMethodError が発生します。

[PARAM] observer:

更新の通知を受けるオブザーバ

[EXCEPTION] NoMethodError:

updateメソッドを持たないオブジェクトをオブザーバに指定した場合に発生します。

changed(state = true) -> bool[permalink][rdoc]

更新フラグを立てます。

更新フラグを指定された内容へ変更し、変更後の更新フラグの状態を返します。 明示的に引数を指定して、更新フラグを初期化することも出来ます。

[PARAM] state:

更新フラグを立てる場合はtrueを、初期化する場合はfalseを指定します。

changed? -> bool[permalink][rdoc]

更新フラグの状態を返します。

count_observers -> Fixnum[permalink][rdoc]

登録されているオブザーバの数を返します。

delete_observer(observer) -> object | nil[permalink][rdoc]

オブザーバを削除します。

指定されたオブジェクトがオブザーバとして登録されていた場合は、 リストからオブジェクトを削除し、取り除かれたオブジェクトを返します。 登録されていなかった場合は、nil を返します。

[PARAM] observer:

削除するオブザーバ

delete_observers -> Array[permalink][rdoc]

オブザーバをすべて削除します。

登録されているオブザーバのリストから全てのオブジェクトを取り除き、 空となったオブザーバのリストを返します。

notify_observers(*arg) -> nil[permalink][rdoc]

オブザーバへ更新を通知します。

更新フラグが立っていた場合は、 登録されているオブザーバの update メソッドを順次呼び出します。 与えられた引数はその update メソッドに渡されます。 与えられた引数の数と登録されているオブザーバのupdate メソッドの引数の数に違いがある場合は 例外ArgumentErrorを発生します。 全てのオブザーバの update メソッドを呼び出し後、更新フラグを初期化します。

[EXCEPTION] ArgumentError:

与えられた引数の数と登録されているオブザーバのupdate メソッドの引数の数に違いがある場合に発生します。