Package org.opentcs.util.annotations
Annotation Interface 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:
- For users of the openTCS API to gain knowledge about upcoming changes.
- For openTCS developers to easily find pending changes during pre-release cleanups.
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional Elements
-
Element Details
-
when
String whenReturns 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 detailsReturns optional details about the scheduled change.- Returns:
- Optional details about the scheduled change.
- Default:
""
-