API 使用規則
- API の文書で他に明記されていない限り、javadoc リファレンスで公開されている API のみのプログラミングがサポートされています。javadoc の API は安定しており、バージョンの境界を超えて削除されません。CARMA API は、今後のリリースで非推奨になる可能性がありますが、文書で定義されているように、将来的に引き続き提供され、プログラマーにより使用できます。CARMA プラグインに他の API が含まれる場合がありますが、これらは非サポートであると見なされなければならず、今後のリリースで変更される可能性があります。
- CARMA モデル API (com.ibm.carma.model パッケージ) は、プログラマーの観点からは読み取り専用であるはずです。つまり、プログラマーは CARMA モデルで手動で項目を作成/追加/移動しないようにする必要があります。階層内のオブジェクトは、refreshXXX() メソッドおよび createXXX() メソッドにより更新されます。API メソッドの使用によらないモデル・オブジェクトの作成はサポートされません。API メソッドを使用せずにモデル・オブジェクトが作成された場合、不整合が生じる可能性があります。
- モデルのすべてのリポジトリー・リソース・リストは、フィルター・ストリングに関連付けられています。デフォルトのフィルター・ストリングは、「*」です。
- ほとんどの CARMA モデルのメソッドでは、メソッドの実行時に CARMA ホストへの接続がアクティブである必要があります。接続がアクティブでない場合、com.ibm.carma.transport.NotConnected 例外がスローされます。
- CARMA ホスト接続をアクティブにする必要がある CARMA メソッドは、メソッド・シグニチャーに org.eclipse.core.runtime.IProgressMonitor パラメーターを持っています。メソッドの実行をキャンセルするために、長期間実行されるメソッドの実行中にチェックされる IProgressMonitor.isCancelled() メソッドを保持します。
- CARMA モデルは、CARMA 階層に対してデータのキャッシュの役割を果たします。プログラマーは、モデルで refreshXXX() メソッドを使用してキャッシュを最新の状態に保つ必要があります。
- CARMA モデルのキャッシュは、初期化する必要があります。キャッシュされていない CARMA 階層の部分がアクセスされた場合、com.ibm.carma.transport.NotSynchronizedException がスローされます。例外を修復するには、オブジェクトで refreshXXX() メソッドを実行します。
- CARMA モデルのキャッシュ内のオブジェクトは、CARMA ホストからの切断時に使用できます。CARMA ホストにアクセスするキャッシュ・オブジェクトに対してメソッドを実行するために、CARMA ホストにアクティブに接続する必要があります。
- モデルの変更は、通知によりリスナーに通信されます。通知は、モデル・オブジェクトを listen しているすべてのアダプターに送られます。リスナーは、org.eclipse.emf.common.notify.Adapter を拡張するクラスを使用してモデルに追加する必要があります。これは、Eclipse モデリング・フレームワーク (EMF) の通知メソッドです。アダプターの通知について詳しくは、EMF の文書を参照してください。
- デフォルトの CARMA UI (外部化された com.ibm.carma.ui.* API を含む) は、アクションとジョブの組み合わせを使用して、CARMA モデルのメソッドを実行します。(org.eclipse.ui.IAction または org.eclipse.ui.IActionDelegate を拡張する) アクションは、モデル・メソッドを実行するために必要なデータを収集する役割を果たします。収集されたデータは、CARMA UI ジョブに渡され、リソースが使用可能になったときにバックグラウンドで実行されるようスケジュールされます。モデルのメソッドにより CARMA 階層で更新が起こった場合、必要に応じて、モデルからリスナーに UI を更新する通知が送信されます。
|
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)