class Delegator

要約

サブクラスにメソッド委譲の仕組みを提供する抽象クラス。

メソッド委譲を行う場合は、本クラスを継承しDelegator#__getobj__を再定義する必要があります。

具体的な使用例については、SimpleDelegatorを参照してください。

目次

インスタンスメソッド

• !
• !=
• ==
• __getobj__
• __setobj__
• freeze
• marshal_dump
• marshal_load
• method_missing
• methods
• protected_methods
• public_methods
• respond_to?
• respond_to_missing?

インスタンスメソッド

! self -> bool[permalink][rdoc][edit]

自身を否定します。

self != obj -> bool[permalink][rdoc][edit]

自身が与えられたオブジェクトと等しくない場合は、真を返します。そうでない場合は、偽を返します。

[PARAM] obj:

比較対象のオブジェクトを指定します。

self == obj -> bool[permalink][rdoc][edit]

自身が与えられたオブジェクトと等しい場合は、真を返します。そうでない場合は、偽を返します。

[PARAM] obj:

比較対象のオブジェクトを指定します。

__getobj__ -> object[permalink][rdoc][edit]

委譲先のオブジェクトを返します。

本メソッドは、サブクラスで再定義する必要があり、デフォルトでは NotImplementedError が発生します。

[EXCEPTION] NotImplementedError:

サブクラスにて本メソッドが再定義されていない場合に発生します。

__setobj__(obj) -> object[permalink][rdoc][edit]

委譲先のオブジェクトをセットします。

[PARAM] obj:

委譲先のオブジェクトを指定します。

[EXCEPTION] NotImplementedError:

サブクラスにて本メソッドが再定義されていない場合に発生します。

freeze -> self[permalink][rdoc][edit]

自身を凍結します。

[SEE_ALSO] Object#freeze

marshal_dump -> object[permalink][rdoc][edit]

シリアライゼーションをサポートするためにDelegator#__getobj__ が返すオブジェクトを返します。

marshal_load(obj) -> object[permalink][rdoc][edit]

シリアライズされたオブジェクトから、Delegator#__getobj__ が返すオブジェクトを再現します。

[PARAM] obj:

Delegator#marshal_dumpの戻り値のコピー

method_missing(m, *args) -> object[permalink][rdoc][edit]

渡されたメソッド名と引数を使って、Delegator#__getobj__ が返すオブジェクトへメソッド委譲を行います。

[PARAM] m:

メソッドの名前（シンボル）

[PARAM] args:

メソッドに渡された引数

[RETURN]

委譲先のメソッドからの返り値

[SEE_ALSO] BasicObject#method_missing

methods -> [Symbol][permalink][rdoc][edit]

そのオブジェクトに対して呼び出せるメソッド名の一覧を返します。このメソッドは public メソッドおよび protected メソッドの名前を返します。

[SEE_ALSO] Object#methods

protected_methods(all = true) -> [Symbol][permalink][rdoc][edit]

そのオブジェクトが理解できる protected メソッド名の一覧を返します。

[PARAM] all:

偽を指定すると __getobj__ のスーパークラスで定義されたメソッドを除きます。

[SEE_ALSO] Object#protected_methods

public_methods(all = true) -> [Symbol][permalink][rdoc][edit]

そのオブジェクトが理解できる public メソッド名の一覧を返します。

[PARAM] all:

偽を指定すると __getobj__ のスーパークラスで定義されたメソッドを除きます。

[SEE_ALSO] Object#public_methods

respond_to?(m) -> bool[permalink][rdoc][edit]

Delegator#__getobj__ が返すオブジェクトが メソッド m を持つとき真を返します。

[PARAM] m:

メソッド名

[SEE_ALSO] Object#respond_to?

respond_to_missing?(m, include_private) -> bool[permalink][rdoc][edit]

[PARAM] m:

メソッド名を指定します。

[PARAM] include_private:

真を指定すると private メソッドも調べます。