PFMethodParameter (MZ Platform Component API (Ver. 4.0))

java.lang.Object
- jp.go.aist.dmrc.platform.util.PFMethodParameter

すべての実装されたインタフェース:

java.io.Serializable, java.lang.Cloneable
```
public class PFMethodParameter
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
メソッド引数オブジェクト。
メソッド引数を動的に取得する機能を持つ。

バージョン:

0.00

関連項目:

PFMethodInvoker, 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`COMPONENT_TYPE` 値取得方法：コンポーネント
`static int`	`EVENT_TYPE` 値取得方法：イベント
`static int`	`EVENT_VALUE_TYPE` 値取得方法：イベント内包データ
`static int`	`METHOD_RESULT_TYPE` 値取得方法：処理済みメソッド返り値
`static int`	`METHOD_RETURN_TYPE` 値取得方法：メソッド返り値
`static int`	`STATIC_VALUE_TYPE` 値取得方法：値固定

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PFMethodParameter(java.lang.Class type)
メソッド引数オブジェクトを作成する。

コンストラクタ
コンストラクタと説明
`PFMethodParameter(java.lang.Class type)` メソッド引数オブジェクトを作成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`backupSourceComponentId(PFConstructBase base)` コンポーネントIDを保持する。
`void`	`clearValue()` 設定されている値をクリアする。
`java.lang.Object`	`clone()` オブジェクトをコピーする。
`boolean`	`equals(java.lang.Object object)` 指定されたオブジェクトがこのオブジェクトと等価かどうかを判定する。
`PFComponent`	`getArgumentComponent()` 引数となるコンポーネントを取得する。
`PFMethodInvoker`	`getArgumentMethodInvoker()` 引数となる起動メソッドを取得する。
`java.lang.String`	`getGetterAliasMethod()` 取得メソッド別名を取得する。
`PFComponent`	`getGetterComponent()` 取得先コンポーネントを取得する。
`java.lang.String`	`getGetterMethod()` 取得メソッド名を取得する。
`PFMethodInvokeDelegation`	`getGetterMethodInvokeDelegation()` 呼び出しメソッドを取得する。
`int`	`getGetType()` データ取得形式を取得する。
`java.lang.Object`	`getValue()` 設定されている値を取得する。
`java.lang.Object`	`getValue(PFComponentConnector connector, java.lang.Object[] resultArray, PFEvent event)` 引数値を取得する。
`java.lang.Class`	`getValueType()` データ型を取得する。
`boolean`	`isComplete()` メソッド引数のデータが完備しているかどうかを取得する。
`boolean`	`isCopying()` コンポーネントコピー中かどうかを取得する。
`void`	`notifyMethodRemoved(PFMethodInvoker invoker)` 起動メソッドの削除の通知を受け、影響のある情報を修正する。
`void`	`resetGetter()` メソッド保持方法の変更（Ver1.0.1）に対する、旧バージョン作成データの互換性確保のための処理を行う。
`void`	`restoreSourceComponent(PFConstructBase base)` コンポーネント情報、メソッドを更新する。
`void`	`setArgumentComponent(PFComponent component)` 引数に与えられたコンポーネントをメソッド引数に設定する。
`void`	`setArgumentMethodInvoker(PFMethodInvoker invoker)` 引数となる起動メソッドを設定する。
`void`	`setArgumentMethodInvokerWithoutClear(PFMethodInvoker invoker)` タイプや取得コンポーネントを変更せずに、引数となる起動メソッドを設定する。
`void`	`setCopying(boolean copying)` コンポーネントコピー中かどうかを設定する。
`void`	`setGetterComponent(PFComponent component)` 引数に与えられたコンポーネントをメソッド呼び出し先とする。
`void`	`setGetterComponentWithoutClear(PFComponent component)` 引数に与えられたコンポーネントをメソッド呼び出し先とする。
`void`	`setGetterMethod(PFComponentInfo getter)` 引数に与えられたメソッドの返り値を値とする.
`void`	`setGetterMethod(PFComponent component, PFMethodInvokeDelegation getter)` 引数に与えられたコンポーネントのメソッドの返り値を値とする。
`void`	`setGetterMethod(PFComponent component, java.lang.String getter)` 引数に与えられたコンポーネントのメソッドの返り値を値とする。
`void`	`setGetterMethod(PFMethodInvokeDelegation getter)` 引数に与えられたメソッドの返り値を値とする。
`void`	`setGetterMethod(java.lang.String getter)` 引数に与えられたメソッドの返り値を値とする。
`void`	`setGetterMethod(java.lang.String getter, java.lang.String alias)` 引数に与えられたメソッドの返り値を値とする。
`void`	`setGetType(int getType)` 引数に与えられたデータ指定形式とする。
`void`	`setNullArgumentComponent()` メソッド引数のコンポーネントとしてnullをセットする。
`void`	`setNullGetterComponent()` メソッド呼出先コンポーネントをnullに設定する。
`void`	`setNullGetterMethod()` 引数に与えられたメソッドの返り値をnullとする。
`void`	`setValue(java.lang.Object value)` 固定値を引数に設定する。
`void`	`setValue(java.lang.String value)` 固定値を引数に設定する。
`java.lang.String`	`toDebugString(int count)` 文字列表現を取得する。
`void`	`updateGetterMethod()` 値取得メソッドを最新に更新する。

クラスから継承されたメソッド java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - METHOD_RETURN_TYPE
```
public static final int METHOD_RETURN_TYPE
```
    値取得方法：メソッド返り値
    
    関連項目:
    
    定数フィールド値
  - STATIC_VALUE_TYPE
```
public static final int STATIC_VALUE_TYPE
```
    値取得方法：値固定
    
    関連項目:
    
    定数フィールド値
  - EVENT_VALUE_TYPE
```
public static final int EVENT_VALUE_TYPE
```
    値取得方法：イベント内包データ
    
    関連項目:
    
    定数フィールド値
  - COMPONENT_TYPE
```
public static final int COMPONENT_TYPE
```
    値取得方法：コンポーネント
    
    関連項目:
    
    定数フィールド値
  - EVENT_TYPE
```
public static final int EVENT_TYPE
```
    値取得方法：イベント
    
    関連項目:
    
    定数フィールド値
  - METHOD_RESULT_TYPE
```
public static final int METHOD_RESULT_TYPE
```
    値取得方法：処理済みメソッド返り値
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - PFMethodParameter
```
public PFMethodParameter(java.lang.Class type)
```
    メソッド引数オブジェクトを作成する。
    
    パラメータ:
    
    type - データ型
- メソッドの詳細
  - setGetType
```
public void setGetType(int getType)
```
    引数に与えられたデータ指定形式とする。
    
    パラメータ:
    
    getType - 値取得形式
  - getGetType
```
public int getGetType()
```
    データ取得形式を取得する。
    
    戻り値:
    
    データ取得形式
  - setGetterComponent
```
public void setGetterComponent(PFComponent component)
```
    引数に与えられたコンポーネントをメソッド呼び出し先とする。
    
    パラメータ:
    
    component - 値取得元コンポーネント
  - setNullGetterComponent
```
public void setNullGetterComponent()
```
    メソッド呼出先コンポーネントをnullに設定する。
  - setGetterComponentWithoutClear
```
public void setGetterComponentWithoutClear(PFComponent component)
```
    引数に与えられたコンポーネントをメソッド呼び出し先とする。ただし、設定されている引数などの情報は更新しない。
    
    パラメータ:
    
    component - 値取得元コンポーネント
  - getGetterComponent
```
public PFComponent getGetterComponent()
```
    取得先コンポーネントを取得する。
    
    戻り値:
    
    取得先コンポーネント
  - updateGetterMethod
```
public void updateGetterMethod()
```
    値取得メソッドを最新に更新する。
  - getGetterMethodInvokeDelegation
```
public PFMethodInvokeDelegation getGetterMethodInvokeDelegation()
```
    呼び出しメソッドを取得する。
    
    戻り値:
    
    呼び出しメソッド
  - setNullGetterMethod
```
public void setNullGetterMethod()
```
    引数に与えられたメソッドの返り値をnullとする。
  - setGetterMethod
```
public void setGetterMethod(PFMethodInvokeDelegation getter)
                     throws PFMethodParameterException
```
    引数に与えられたメソッドの返り値を値とする。
    
    パラメータ:
    
    getter - 値取得メソッド名
    
    例外:
    
    PFMethodParameterException - メソッド引数取得メソッドの不正
  - setGetterMethod
```
public void setGetterMethod(PFComponentInfo getter)
                     throws PFMethodParameterException
```
    引数に与えられたメソッドの返り値を値とする.
    
    パラメータ:
    
    getter - 値取得のためのリモートメソッド情報
    
    例外:
    
    PFMethodParameterException - メソッド引数取得メソッドの不正
  - setGetterMethod
```
public void setGetterMethod(PFComponent component,
                            PFMethodInvokeDelegation getter)
                     throws PFMethodParameterException
```
    引数に与えられたコンポーネントのメソッドの返り値を値とする。
    
    パラメータ:
    
    component - 値取得元コンポーネント
    
    getter - 値取得メソッド
    
    例外:
    
    PFMethodParameterException - メソッド引数取得メソッドの不正
  - setGetterMethod
```
public void setGetterMethod(java.lang.String getter)
                     throws PFMethodParameterException
```
    引数に与えられたメソッドの返り値を値とする。
    
    パラメータ:
    
    getter - 値取得メソッド名
    
    例外:
    
    PFMethodParameterException - メソッド引数取得メソッドの不正
  - setGetterMethod
```
public void setGetterMethod(PFComponent component,
                            java.lang.String getter)
                     throws PFMethodParameterException
```
    引数に与えられたコンポーネントのメソッドの返り値を値とする。
    
    パラメータ:
    
    component - 値取得元コンポーネント
    
    getter - 値取得メソッド名
    
    例外:
    
    PFMethodParameterException - メソッド引数取得メソッドの不正
  - setGetterMethod
```
public void setGetterMethod(java.lang.String getter,
                            java.lang.String alias)
                     throws PFMethodParameterException
```
    引数に与えられたメソッドの返り値を値とする。
    
    パラメータ:
    
    getter - 値取得メソッド名
    
    alias - 値取得メソッド別名
    
    例外:
    
    PFMethodParameterException - メソッド引数取得メソッドの不正
  - getGetterMethod
```
public java.lang.String getGetterMethod()
```
    取得メソッド名を取得する。
    
    戻り値:
    
    取得メソッド名
  - getGetterAliasMethod
```
public java.lang.String getGetterAliasMethod()
```
    取得メソッド別名を取得する。
    
    戻り値:
    
    取得メソッド名
  - setArgumentComponent
```
public void setArgumentComponent(PFComponent component)
                          throws PFMethodParameterException
```
    引数に与えられたコンポーネントをメソッド引数に設定する。
    
    パラメータ:
    
    component - 引数コンポーネント
    
    例外:
    
    PFMethodParameterException - コンポーネントデータ型の不正
  - setNullArgumentComponent
```
public void setNullArgumentComponent()
```
    メソッド引数のコンポーネントとしてnullをセットする。
  - getArgumentComponent
```
public PFComponent getArgumentComponent()
```
    引数となるコンポーネントを取得する。
    
    戻り値:
    
    引数コンポーネント
  - setArgumentMethodInvoker
```
public void setArgumentMethodInvoker(PFMethodInvoker invoker)
```
    引数となる起動メソッドを設定する。
    
    パラメータ:
    
    invoker - 起動メソッド
  - setArgumentMethodInvokerWithoutClear
```
public void setArgumentMethodInvokerWithoutClear(PFMethodInvoker invoker)
```
    タイプや取得コンポーネントを変更せずに、引数となる起動メソッドを設定する。 (メソッド戻り値型で、取得コンポーネントにリモートを使用している場合のみ利用可)
    
    パラメータ:
    
    invoker - 起動メソッド
  - getArgumentMethodInvoker
```
public PFMethodInvoker getArgumentMethodInvoker()
```
    引数となる起動メソッドを取得する。
    
    戻り値:
    
    起動メソッド
  - getValueType
```
public java.lang.Class getValueType()
```
    データ型を取得する。
    
    戻り値:
    
    データ型
  - setValue
```
public void setValue(java.lang.Object value)
```
    固定値を引数に設定する。
    
    パラメータ:
    
    value - 値
  - setValue
```
public void setValue(java.lang.String value)
              throws PFMethodParameterException
```
    固定値を引数に設定する。
    
    パラメータ:
    
    value - 固定値（文字列表現）
    
    例外:
    
    PFMethodParameterException - リテラルフォーマット不正
  - getValue
```
public java.lang.Object getValue()
```
    設定されている値を取得する。
  - clearValue
```
public void clearValue()
```
    設定されている値をクリアする。
  - getValue
```
public java.lang.Object getValue(PFComponentConnector connector,
                                 java.lang.Object[] resultArray,
                                 PFEvent event)
                          throws PFMethodParameterException
```
    引数値を取得する。
    設定されたメソッドを起動し、引数値を取得する。
    
    パラメータ:
    
    connector - コンポーネントコネクタ
    
    resultArray - 処理結果配列
    
    event - 発生イベント
    
    戻り値:
    
    値オブジェクト
    
    例外:
    
    PFMethodParameterException - メソッド引数取得の失敗
  - notifyMethodRemoved
```
public void notifyMethodRemoved(PFMethodInvoker invoker)
```
    起動メソッドの削除の通知を受け、影響のある情報を修正する。
    
    パラメータ:
    
    invoker - 削除された起動メソッド
  - resetGetter
```
public void resetGetter()
```
    メソッド保持方法の変更（Ver1.0.1）に対する、旧バージョン作成データの互換性確保のための処理を行う。
  - clone
```
public java.lang.Object clone()
```
    オブジェクトをコピーする。
    
    オーバーライド:
    
    clone クラス内 java.lang.Object
    
    戻り値:
    
    このオブジェクトの複製
  - backupSourceComponentId
```
public void backupSourceComponentId(PFConstructBase base)
```
    コンポーネントIDを保持する。
    
    パラメータ:
    
    base - 構築コンポーネント
  - restoreSourceComponent
```
public void restoreSourceComponent(PFConstructBase base)
```
    コンポーネント情報、メソッドを更新する。
    
    パラメータ:
    
    base - 構築コンポーネント
  - isCopying
```
public boolean isCopying()
```
    コンポーネントコピー中かどうかを取得する。
    
    戻り値:
    
    コンポーネントコピー中の場合true
  - setCopying
```
public void setCopying(boolean copying)
```
    コンポーネントコピー中かどうかを設定する。
    
    パラメータ:
    
    copying - コンポーネントコピー中の場合true
  - toDebugString
```
public java.lang.String toDebugString(int count)
```
    文字列表現を取得する。
    
    パラメータ:
    
    count - インデント数
    
    戻り値:
    
    文字列表現
  - equals
```
public boolean equals(java.lang.Object object)
```
    指定されたオブジェクトがこのオブジェクトと等価かどうかを判定する。
    
    オーバーライド:
    
    equals クラス内 java.lang.Object
    
    パラメータ:
    
    object - オブジェクト
    
    戻り値:
    
    等価の場合true
  - isComplete
```
public boolean isComplete()
```
    メソッド引数のデータが完備しているかどうかを取得する。
    
    戻り値:
    
    メソッド引数のデータが完備している場合true

クラス PFMethodParameter

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

METHOD_RETURN_TYPE

STATIC_VALUE_TYPE

EVENT_VALUE_TYPE

COMPONENT_TYPE

EVENT_TYPE

METHOD_RESULT_TYPE

コンストラクタの詳細

PFMethodParameter

メソッドの詳細

setGetType

getGetType

setGetterComponent

setNullGetterComponent

setGetterComponentWithoutClear

getGetterComponent

updateGetterMethod

getGetterMethodInvokeDelegation

setNullGetterMethod

setGetterMethod

setGetterMethod

setGetterMethod

setGetterMethod

setGetterMethod

setGetterMethod

getGetterMethod

getGetterAliasMethod

setArgumentComponent

setNullArgumentComponent

getArgumentComponent

setArgumentMethodInvoker

setArgumentMethodInvokerWithoutClear

getArgumentMethodInvoker

getValueType

setValue

setValue

getValue

clearValue

getValue

notifyMethodRemoved

resetGetter

clone

backupSourceComponentId

restoreSourceComponent

isCopying

setCopying

toDebugString

equals

isComplete