Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. If there is no existing JIRA case that provoked the API change request, create a JIRA case proposing the extension.
    1. If relevant, provide links to the superseding APIs in the Jira case.
    2. Assign the case to the governing architect.
  2. Send notification of the case to the team leads / architects involved with the affected project.
  3. Implementation of extension to interface XYZ
    1. Create a new child interface called ExtendedXYZ XYZExtended (if it does not already exist) that extends XYZ, add the new method(s) to that

2) Where the existing method is called, add an "instanceof" check. If true, cast and delegate. If not, retain the current behavior
3) @Deprecate the existing interface, with lots of detail in the javadoc (see the guidelines here).
4) Doc the new interface, usage, deprecation of the old, etc. in the appropriate spots (Embed guide, What's New?, SDK, etc.)

  1. 2)
    1. XYZExtended.
    2. Where the existing method is called, add an "instanceof" check. If true, cast and delegate. If not, retain the current behavior
    3)
    1. @Deprecate the existing interface, with lots of detail in the javadoc (see the guidelines here)
    .
    4) Doc
    1. Document the new interface, usage, deprecation of the old, etc. in the appropriate
    spots (Embed guide, What's New?, SDK, etc.)
    1. locations
  2. If there's agreement to proceed, make the change.
  3. The architect should then work with PM and other stakeholders to determine how long the deprecated features should be supported.
  4. Keep the case open and set the fix version for the next major release when there's agreement that the deprecated features can be removed

...