Annotation Interface ScheduledApiChange


Marks an API detail (class, method, field) that is scheduled for an incompatible change.

This annotation should not be used outside the source code of the openTCS project itself. It should not be considered part of the public API.

This annotation is intended to be used as a supplement for @Deprecated for two purposes:

  1. For users of the openTCS API to gain knowledge about upcoming changes.
  2. For openTCS developers to easily find pending changes during pre-release cleanups.
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Returns the date or version at which the API is scheduled to be changed.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Returns optional details about the scheduled change.
  • Element Details

    • when

      String when
      Returns the date or version at which the API is scheduled to be changed.
      Returns:
      The date or version at which the API is scheduled to be changed.
    • details

      String details
      Returns optional details about the scheduled change.
      Returns:
      Optional details about the scheduled change.
      Default:
      ""