Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[core] Introduce a new @DeprecatedUntil annotation #4931

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/

package net.sourceforge.pmd.annotation;

import java.lang.annotation.Documented;

/**
* Tags a deprecated member that should not be removed before PMD {@link #major()}.
* Such members were made deprecated on the PMD {@link #major()} development branch but
* are to be kept for backwards compatibility on the day of the PMD {@link #major()} release.
*/
@Documented
public @interface DeprecatedUntil {
/**
* @return The major version until which the deprecated API is to be kept and supported.
*/
String major();

/**
* @return The future outcome for this API, weather it's to be removed completely or converted to an {@link InternalApi}
*/
FutureOutcome future();

enum FutureOutcome {
REMOVAL, INTERNALIZATION;
}
}