Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Swordfish Documentation: API Policy
API Definitions
Swordfish is defined to be an extensible Framework and as such provides an official API that should be used to adapt and extend Swordfish it is defined in the org.eclipse.swordfish.api bundle. Beside the official API Swordfish also provides provisional API's that expose generic functionality to more easily extend Swordfish. Examples can be found in the bundles org.eclipse.swordfish.core.planner and [http://dev.eclipse.org/svnroot/soa/org.eclipse.swordfish/trunk/rt/org.eclipse.swordfish.core.resolver/ org.eclipse.swordfish.core.resolver. Everything else is seen as internal and placed in the org.eclipse.swordfish.internal namespace. In opposite to most other projects we are not exporting internal packages.
Stability of API
Swordfish still being in incubation does not give any commitment to keep the current API, even the declared one, stable nor to further maintain it for a specific period. Currently first projects are starting to use and extend Swordfish. Based on the feedback of these projects we expect to adapt declared API, but also to move some of the provisional API's to the declared one. Subsequently release our 1.0 in the last quarter of 2010. As part of the graduation we also will further detail our API policy regarding the commitment to the API and the guaranted period of maintance.