Reglas de la API para compromisos
- Solamente las API expuestas en la referencia de javadoc reciben soporte para programación a menos que se indique de otro modo en la documentación de la API. Las API de los javadoc son estables y no se eliminarán de los límites de las versiones. Las API de CARMA pueden caer en desuso en releases posteriores pero deberían seguir estando disponibles para los programadores y éstos deberían poder seguir utilizándolas en un futuro tal como se define en la documentación. Es posible que encuentre otras API en los plug-in de CARMA pero debe tener en cuenta pueden no recibir soporte y estar sujetas a cambios en posteriores releases.
- Las API del modelo de CARMA (paquete com.ibm.carma.model) significa que solamente son de lectura desde el punto de vista del programador, por ejemplo, el programador no debería intentar crear/añadir/trasladar elementos manualmente al modelo de CARMA. Los objetos de la jerarquía significa que se deben actualizar a través de los métodos refreshXXX() y createXXX(). La creación de objetos de modelo sin utilizar los métodos de la API no recibe soporte. Si se crean objetos de modelo sin utilizar los métodos de la API, se pueden producir incoherencias.
- Todas las listas de recursos de repositorios del modelo están asociadas a una serie de filtro. La serie de filtro predeterminada es “*”.
- La mayoría de métodos de modelo CARMA necesitan que la conexión al host de CARMA esté activa cuando se ejecuta el método. Si la conexión no está activa, se emitirá una excepción com.ibm.carma.transport.NotConnected.
- Los métodos CARMA que necesitan activar la conexión de host CARMA tiene un parámetro org.eclipse.core.runtime.IProgressMonitor en la firma del método. Para cancelar la ejecución del método se respecta el método IProgressMonitor.isCancelled() que se comprueba durante la ejecución del método de ejecución larga.
- El modelo de CARMA sirve como una memoria caché de datos para la jerarquía de CARMA. Es responsabilidad del programados conservar la memoria caché en buen estado mediante los métodos refreshXXX() en el modelo.
- La memoria caché del modelo CARMA se debe inicializar. Si se accede a una parte de la jerarquía de CARMA que no está almacenada en memoria caché, se emitirá una excepción com.ibm.carma.transport.NotSynchronizedException. Para reparar la excepción, ejecute un método refreshXXX() en el objeto.
- Los objetos de la memoria caché del modelo de CARMA están disponibles cuando se desconectan del host de CARMA. El host de CARMA debe estar conectado de forma activa para poder ejecutar métodos en los objetos de memoria caché a los que el host de CARMA accede.
- Los cambios de modelo se comunican a parte de los escuchas a través de una notificación. La notificación va más allá de cualquier escucha en el objeto modelo. Los escuchas debería añadirse al modelo utilizando una clase que amplíe org.eclipse.emf.common.notify.Adapter.
Se trata de un método de notificación EMF (Eclipse Modeling Framework). Consulte la documentación de EMF si desea más información sobre la notificación del adaptador.
- La interfaz de usuario de CARMA predeterminada (incluidas las API externalizadas com.ibm.carma.ui.*) utilizan una combinación de acciones y trabajos para ejecutar métodos en el modelo CARMA. La acción (ampliando org.eclipse.ui.IAction o org.eclipse.ui.IActionDelegate) es responsable de recopilar los datos necesarios para ejecutar el método de modelo. Los datos recopilados se gestionan fuera del trabajo de la interfaz de usuario de CARMA, que se planifica para su ejecución en segundo plano cuando los recursos están disponibles. Si el método de modelo provoca actualizaciones en la jerarquía de CARMA, las notificaciones se enviarán desde el modelo a los escuchas que actualicen la interfaz de usuario según convenga.
|
Este centro de información está equipado con tecnología Eclipse. (http://www.eclipse.org)