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

Update at-since Javadoc #4877

Merged
merged 1 commit into from
Aug 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/FilePath.java
Original file line number Diff line number Diff line change
Expand Up @@ -1262,7 +1262,7 @@ public Boolean invoke(File f, VirtualChannel channel) throws IOException, Interr
/**
* Deletes all suffixes recursively.
* @throws IOException if it exists but could not be successfully deleted
* @since TODO
* @since 2.244
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
public void deleteSuffixesRecursive() throws IOException, InterruptedException {
act(new DeleteSuffixesRecursive());
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/Functions.java
Original file line number Diff line number Diff line change
Expand Up @@ -1161,7 +1161,7 @@ public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigUnclassi
/**
* Checks if the current security principal has one of the supplied permissions.
*
* @since TODO
* @since 2.238
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
public static boolean hasAnyPermission(AccessControlled ac, Permission[] permissions) {
if (permissions == null || permissions.length == 0) {
Expand All @@ -1176,7 +1176,7 @@ public static boolean hasAnyPermission(AccessControlled ac, Permission[] permiss
* degrades gracefully if "it" is not an {@link AccessControlled} object.
* Otherwise it will perform no check and that problem is hard to notice.
*
* @since TODO
* @since 2.238
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
public static boolean hasAnyPermission(Object object, Permission[] permissions) throws IOException, ServletException {
if (permissions == null || permissions.length == 0) {
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/hudson/Launcher.java
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ protected Launcher(@NonNull Launcher launcher) {
* @param run The run that requested the command interpretation, could be <code>null</code> if outside of a run context.
* @param builder The builder that asked to run this command
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public void prepareFilterRules(@CheckForNull Run<?,?> run, @NonNull EnvVarsFilterableBuilder builder){
Expand Down Expand Up @@ -483,7 +483,7 @@ public ProcStarter writeStdin() {
/**
* Specify the build step that want to run the command to enable the environment filters
* @return {@code this}
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public ProcStarter buildStep(EnvVarsFilterableBuilder envVarsFilterableBuilder){
Expand All @@ -493,7 +493,7 @@ public ProcStarter buildStep(EnvVarsFilterableBuilder envVarsFilterableBuilder){

/**
* @return if set, returns the build step that wants to run the command
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public @CheckForNull
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/PluginManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -2242,7 +2242,7 @@ private PluginUpdateInfo(String pluginName, String message) {
/**
* {@link AdministrativeMonitor} that checks if there are any plugins that are deprecated.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(NoExternalUse.class)
@Symbol("pluginDeprecation")
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/PluginWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ public boolean hasMandatoryDependencies() {
* Is this plugin deprecated?
*
* @return {@code true} if and only if an update site reports deprecations for this plugin.
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(NoExternalUse.class)
public boolean isDeprecated() {
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/model/AbstractProject.java
Original file line number Diff line number Diff line change
Expand Up @@ -2080,7 +2080,7 @@ public static abstract class LabelValidator implements ExtensionPoint {
* @param label The label that the job wants to restrict itself to.
* @return The validation result.
*
* @since TODO
* @since 2.243
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@NonNull
public FormValidation checkItem(@NonNull Item item, @NonNull Label label) {
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/model/DownloadService.java
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ public String getId() {
* @param clazz The class to use to generate an ID.
* @return The ID generated based on the specified class.
*
* @since TODO
* @since 2.244
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@NonNull
public static String idFor(@NonNull Class<?> clazz) {
Expand Down Expand Up @@ -460,7 +460,7 @@ public static ExtensionList<Downloadable> all() {
*
* @param clazz The class to use to determine the downloadable's ID.
*
* @since TODO
* @since 2.244
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@CheckForNull
public static Downloadable get(@NonNull Class<?> clazz) {
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/model/Fingerprint.java
Original file line number Diff line number Diff line change
Expand Up @@ -1192,7 +1192,7 @@ public int size() {
/**
* Returns the persisted facets.
*
* @since TODO
* @since 2.242
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
public final @NonNull PersistedList<FingerprintFacet> getPersistedFacets() {
return facets;
Expand Down Expand Up @@ -1359,7 +1359,7 @@ public Api getApi() {
/**
* Deletes the {@link Fingerprint} in the Storage with the given unique id.
*
* @since TODO
* @since 2.242
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
public static void delete(@NonNull String id) throws IOException {
FingerprintStorage.get().delete(id);
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/model/ParameterDefinition.java
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ public ParameterValue getDefaultParameterValue() {

/**
* Checks whether a given value is valid for this definition.
* @since TODO
* @since 2.244
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* @param value The value to validate.
* @return True if the value is valid for this definition. False if it is invalid.
*/
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/hudson/model/UpdateSite.java
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ public final class Data {
/**
* Mapping of plugin IDs to deprecation notices
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
private final Map<String, Deprecation> deprecations = new HashMap<>();

Expand Down Expand Up @@ -650,7 +650,7 @@ public Set<Warning> getWarnings() {
/**
* Returns the deprecations provided by the update site
* @return the deprecations provided by the update site
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(NoExternalUse.class)
public Map<String, Deprecation> getDeprecations() {
Expand Down Expand Up @@ -842,7 +842,7 @@ public boolean includes(VersionNumber number) {
/**
* Represents a deprecation of a certain component. Jenkins project policy determines exactly what it means.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(NoExternalUse.class)
public static final class Deprecation {
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/hudson/model/labels/LabelExpression.java
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ public LabelOperatorPrecedence precedence() {
*
* @param label The (partial) label for which auto-completion is being requested.
* @return A set of auto-completion candidates.
* @since TODO
* @since 2.243
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@NonNull
public static AutoCompletionCandidates autoComplete(@Nullable String label) {
Expand All @@ -256,7 +256,7 @@ public static AutoCompletionCandidates autoComplete(@Nullable String label) {
*
* @param expression The expression to validate.
* @return The validation result.
* @since TODO
* @since 2.243
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@NonNull
public static FormValidation validate(@Nullable String expression) {
Expand All @@ -270,7 +270,7 @@ public static FormValidation validate(@Nullable String expression) {
* @param item The context item (like a job or a folder), if applicable; used for potential additional
* restrictions via {@link LabelValidator} instances.
* @return The validation result.
* @since TODO
* @since 2.243
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
// FIXME: Should the messages be moved, or kept where they are for backward compatibility?
@NonNull
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/slaves/WorkspaceList.java
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ public static FilePath tempDir(FilePath ws) {

/**
* The token that combines the project name and unique number to create unique workspace directory.
* @since TODO
* @since 2.244
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
public static final String COMBINATOR = SystemProperties.getString(WorkspaceList.class.getName(),"@");
}
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/tasks/BatchFile.java
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public BatchFile(String command) {
/**
* Set local environment variable filter rules
* @param configuredLocalRules list of local environment filter rules
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
@DataBoundSetter
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/tasks/Shell.java
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public Shell(String command) {
/**
* Set local environment variable filter rules
* @param configuredLocalRules list of local environment filter rules
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
@DataBoundSetter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,14 @@ public static FingerprintStorage getFileFingerprintStorage() {
* For reference, see {@link FileFingerprintStorage#iterateAndCleanupFingerprints(TaskListener)}
* For cleaning up the fingerprint {@link #cleanFingerprint(Fingerprint, TaskListener)} may be used.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

daniel-beck marked this conversation as resolved.
Show resolved Hide resolved
*/
public abstract void iterateAndCleanupFingerprints(TaskListener taskListener);

/**
* This method performs the cleanup of the given fingerprint.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

daniel-beck marked this conversation as resolved.
Show resolved Hide resolved
*/
public boolean cleanFingerprint(@NonNull Fingerprint fingerprint, TaskListener taskListener) {
try {
Expand Down Expand Up @@ -140,7 +140,7 @@ protected Fingerprint getFingerprint(Fingerprint fp) throws IOException {
}

/**
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

daniel-beck marked this conversation as resolved.
Show resolved Hide resolved
*/
@Override public FingerprintStorageDescriptor getDescriptor() {
return (FingerprintStorageDescriptor) super.getDescriptor();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* Plugins may want to contribute additional restrictions on the use of specific labels for specific context items.
* This extension point allows such restrictions.
*
* @since TODO
* @since 2.243
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
public interface LabelValidator extends ExtensionPoint {

Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/jenkins/tasks/SimpleBuildStep.java
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ default void perform(@NonNull Run<?, ?> run, @NonNull FilePath workspace, @NonNu
* @param listener a place to send output
* @throws InterruptedException if the step is interrupted
* @throws IOException if something goes wrong; use {@link AbortException} for a polite error
* @since TODO
* @since 2.241
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
default void perform(@NonNull Run<?, ?> run, @NonNull FilePath workspace, @NonNull EnvVars env, @NonNull Launcher launcher,
@NonNull TaskListener listener) throws InterruptedException, IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Exception that occurs during the environment filtering process, with helper to track the source.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public class EnvVarsFilterException extends AbortException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* Configuration of the filter rules that are applied globally,
* after filtering which rule applies on which builder
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Extension
@Symbol("envVarsFilter")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
*
* The local rules are applied before the global ones.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public interface EnvVarsFilterGlobalRule extends Describable<EnvVarsFilterGlobalRule>, EnvVarsFilterRule, ExtensionPoint, Serializable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
*
* The local rules are applied before the global ones.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public interface EnvVarsFilterLocalRule extends Describable<EnvVarsFilterLocalRule>, EnvVarsFilterRule, ExtensionPoint, Serializable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* if the rule is applicable to a given builder and then applied every time. <p>
* For global rule it's the inverse, the rule itself determines when it's applicable.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public abstract class EnvVarsFilterLocalRuleDescriptor extends Descriptor<EnvVarsFilterLocalRule> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Information that is used for the environment filtering process.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public class EnvVarsFilterRuleContext {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
/**
* Helper class that provide the list of rules (local + global) for a given builder.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(NoExternalUse.class)
public class EnvVarsFilterRuleWrapper implements Serializable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
/**
* Builder step that wants to integrate local environment filter rules should implement this interface
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(Beta.class)
public interface EnvVarsFilterableBuilder {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
/**
* Local rule that removes all the non-retained variables for that step.
*
* @since TODO
* @since 2.246
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@Restricted(NoExternalUse.class)
public class RetainVariablesLocalRule implements EnvVarsFilterLocalRule {
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/jenkins/util/SystemProperties.java
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
* <p>While it looks like it on first glance, this cannot be mapped to {@link EnvVars},
* because {@link EnvVars} is only for build variables, not Jenkins itself variables.
*
* @since TODO
* @since 2.236
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*/
@SuppressFBWarnings(value = "ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD", justification = "Currently Jenkins instance may have one ond only one context")
public class SystemProperties {
Expand Down