Package org.opentcs.util.annotations

Annotationsschnittstelle ScheduledApiChange

@Target({CONSTRUCTOR,FIELD,METHOD,TYPE}) @Retention(SOURCE) @Documented @Repeatable(ScheduledApiChanges.class) public @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.

  • Erforderliche Elemente - Übersicht

    Erforderliche Elemente
    Modifizierer und Typ
    Erforderliches Element
    Beschreibung
    String
    when
    Returns the date or version at which the API is scheduled to be changed.

  • Optionale Elemente - Übersicht

    Optionale Elemente
    Modifizierer und Typ
    Optionales Element
    Beschreibung
    String
    details
    Returns optional details about the scheduled change.

  • Elementdetails

    • when

      String when
      Returns the date or version at which the API is scheduled to be changed.
      Gibt zurück:
      The date or version at which the API is scheduled to be changed.

    • details

      String details
      Returns optional details about the scheduled change.
      Gibt zurück:
      Optional details about the scheduled change.
      Standard:
      ""