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 主机的高速缓存对象执行方法。
- 会通过通知将模型更改传递到侦听器。该通知会发送到对模型对象进行侦听的任何适配器。应该通过使用对
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)