From 304ad624269a32463158b6ed17740e2f325d9d44 Mon Sep 17 00:00:00 2001 From: Daniel Beck Date: Mon, 27 Jul 2020 10:08:44 +0200 Subject: [PATCH] Update at-since Javadoc --- core/src/main/java/hudson/FilePath.java | 2 +- core/src/main/java/hudson/Functions.java | 4 ++-- core/src/main/java/hudson/Launcher.java | 6 +++--- core/src/main/java/hudson/PluginManager.java | 2 +- core/src/main/java/hudson/PluginWrapper.java | 2 +- core/src/main/java/hudson/model/AbstractProject.java | 2 +- core/src/main/java/hudson/model/DownloadService.java | 4 ++-- core/src/main/java/hudson/model/Fingerprint.java | 4 ++-- core/src/main/java/hudson/model/ParameterDefinition.java | 2 +- core/src/main/java/hudson/model/UpdateSite.java | 6 +++--- core/src/main/java/hudson/model/labels/LabelExpression.java | 6 +++--- core/src/main/java/hudson/slaves/WorkspaceList.java | 2 +- core/src/main/java/hudson/tasks/BatchFile.java | 2 +- core/src/main/java/hudson/tasks/Shell.java | 2 +- .../main/java/jenkins/fingerprints/FingerprintStorage.java | 6 +++--- core/src/main/java/jenkins/model/labels/LabelValidator.java | 2 +- core/src/main/java/jenkins/tasks/SimpleBuildStep.java | 2 +- .../java/jenkins/tasks/filters/EnvVarsFilterException.java | 2 +- .../tasks/filters/EnvVarsFilterGlobalConfiguration.java | 2 +- .../java/jenkins/tasks/filters/EnvVarsFilterGlobalRule.java | 2 +- .../java/jenkins/tasks/filters/EnvVarsFilterLocalRule.java | 2 +- .../tasks/filters/EnvVarsFilterLocalRuleDescriptor.java | 2 +- .../jenkins/tasks/filters/EnvVarsFilterRuleContext.java | 2 +- .../jenkins/tasks/filters/EnvVarsFilterRuleWrapper.java | 2 +- .../jenkins/tasks/filters/EnvVarsFilterableBuilder.java | 2 +- .../tasks/filters/impl/RetainVariablesLocalRule.java | 2 +- core/src/main/java/jenkins/util/SystemProperties.java | 2 +- 27 files changed, 38 insertions(+), 38 deletions(-) diff --git a/core/src/main/java/hudson/FilePath.java b/core/src/main/java/hudson/FilePath.java index e24f50bd4ba3..ce8feaff07b1 100644 --- a/core/src/main/java/hudson/FilePath.java +++ b/core/src/main/java/hudson/FilePath.java @@ -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 */ public void deleteSuffixesRecursive() throws IOException, InterruptedException { act(new DeleteSuffixesRecursive()); diff --git a/core/src/main/java/hudson/Functions.java b/core/src/main/java/hudson/Functions.java index cb679ef27818..7d0ec6cac09c 100644 --- a/core/src/main/java/hudson/Functions.java +++ b/core/src/main/java/hudson/Functions.java @@ -1161,7 +1161,7 @@ public static Collection getSortedDescriptorsForGlobalConfigUnclassi /** * Checks if the current security principal has one of the supplied permissions. * - * @since TODO + * @since 2.238 */ public static boolean hasAnyPermission(AccessControlled ac, Permission[] permissions) { if (permissions == null || permissions.length == 0) { @@ -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 */ public static boolean hasAnyPermission(Object object, Permission[] permissions) throws IOException, ServletException { if (permissions == null || permissions.length == 0) { diff --git a/core/src/main/java/hudson/Launcher.java b/core/src/main/java/hudson/Launcher.java index 53bc24f5ccba..d248bd519243 100644 --- a/core/src/main/java/hudson/Launcher.java +++ b/core/src/main/java/hudson/Launcher.java @@ -116,7 +116,7 @@ protected Launcher(@NonNull Launcher launcher) { * @param run The run that requested the command interpretation, could be null if outside of a run context. * @param builder The builder that asked to run this command * - * @since TODO + * @since 2.246 */ @Restricted(Beta.class) public void prepareFilterRules(@CheckForNull Run run, @NonNull EnvVarsFilterableBuilder builder){ @@ -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 */ @Restricted(Beta.class) public ProcStarter buildStep(EnvVarsFilterableBuilder envVarsFilterableBuilder){ @@ -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 */ @Restricted(Beta.class) public @CheckForNull diff --git a/core/src/main/java/hudson/PluginManager.java b/core/src/main/java/hudson/PluginManager.java index d70df7c5c65a..150754805283 100644 --- a/core/src/main/java/hudson/PluginManager.java +++ b/core/src/main/java/hudson/PluginManager.java @@ -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 */ @Restricted(NoExternalUse.class) @Symbol("pluginDeprecation") diff --git a/core/src/main/java/hudson/PluginWrapper.java b/core/src/main/java/hudson/PluginWrapper.java index 2a94146694e0..1ca477dce1da 100644 --- a/core/src/main/java/hudson/PluginWrapper.java +++ b/core/src/main/java/hudson/PluginWrapper.java @@ -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 */ @Restricted(NoExternalUse.class) public boolean isDeprecated() { diff --git a/core/src/main/java/hudson/model/AbstractProject.java b/core/src/main/java/hudson/model/AbstractProject.java index 7f0c8607a4ba..c1c8405c4031 100644 --- a/core/src/main/java/hudson/model/AbstractProject.java +++ b/core/src/main/java/hudson/model/AbstractProject.java @@ -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 */ @NonNull public FormValidation checkItem(@NonNull Item item, @NonNull Label label) { diff --git a/core/src/main/java/hudson/model/DownloadService.java b/core/src/main/java/hudson/model/DownloadService.java index dc4f256b5e79..c4c62657f7f0 100644 --- a/core/src/main/java/hudson/model/DownloadService.java +++ b/core/src/main/java/hudson/model/DownloadService.java @@ -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 */ @NonNull public static String idFor(@NonNull Class clazz) { @@ -460,7 +460,7 @@ public static ExtensionList all() { * * @param clazz The class to use to determine the downloadable's ID. * - * @since TODO + * @since 2.244 */ @CheckForNull public static Downloadable get(@NonNull Class clazz) { diff --git a/core/src/main/java/hudson/model/Fingerprint.java b/core/src/main/java/hudson/model/Fingerprint.java index 7f564d418b80..58b5f99a27f0 100644 --- a/core/src/main/java/hudson/model/Fingerprint.java +++ b/core/src/main/java/hudson/model/Fingerprint.java @@ -1192,7 +1192,7 @@ public int size() { /** * Returns the persisted facets. * - * @since TODO + * @since 2.242 */ public final @NonNull PersistedList getPersistedFacets() { return facets; @@ -1359,7 +1359,7 @@ public Api getApi() { /** * Deletes the {@link Fingerprint} in the Storage with the given unique id. * - * @since TODO + * @since 2.242 */ public static void delete(@NonNull String id) throws IOException { FingerprintStorage.get().delete(id); diff --git a/core/src/main/java/hudson/model/ParameterDefinition.java b/core/src/main/java/hudson/model/ParameterDefinition.java index d33d9a8acfc5..b815e89a2325 100644 --- a/core/src/main/java/hudson/model/ParameterDefinition.java +++ b/core/src/main/java/hudson/model/ParameterDefinition.java @@ -227,7 +227,7 @@ public ParameterValue getDefaultParameterValue() { /** * Checks whether a given value is valid for this definition. - * @since TODO + * @since 2.244 * @param value The value to validate. * @return True if the value is valid for this definition. False if it is invalid. */ diff --git a/core/src/main/java/hudson/model/UpdateSite.java b/core/src/main/java/hudson/model/UpdateSite.java index 6938e62a2e9c..41bda4634cc0 100644 --- a/core/src/main/java/hudson/model/UpdateSite.java +++ b/core/src/main/java/hudson/model/UpdateSite.java @@ -562,7 +562,7 @@ public final class Data { /** * Mapping of plugin IDs to deprecation notices * - * @since TODO + * @since 2.246 */ private final Map deprecations = new HashMap<>(); @@ -650,7 +650,7 @@ public Set getWarnings() { /** * Returns the deprecations provided by the update site * @return the deprecations provided by the update site - * @since TODO + * @since 2.246 */ @Restricted(NoExternalUse.class) public Map getDeprecations() { @@ -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 */ @Restricted(NoExternalUse.class) public static final class Deprecation { diff --git a/core/src/main/java/hudson/model/labels/LabelExpression.java b/core/src/main/java/hudson/model/labels/LabelExpression.java index 1c627fe80bdc..38e23e591130 100644 --- a/core/src/main/java/hudson/model/labels/LabelExpression.java +++ b/core/src/main/java/hudson/model/labels/LabelExpression.java @@ -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 */ @NonNull public static AutoCompletionCandidates autoComplete(@Nullable String label) { @@ -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 */ @NonNull public static FormValidation validate(@Nullable String expression) { @@ -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 */ // FIXME: Should the messages be moved, or kept where they are for backward compatibility? @NonNull diff --git a/core/src/main/java/hudson/slaves/WorkspaceList.java b/core/src/main/java/hudson/slaves/WorkspaceList.java index 6a4ab03da448..81166310d046 100644 --- a/core/src/main/java/hudson/slaves/WorkspaceList.java +++ b/core/src/main/java/hudson/slaves/WorkspaceList.java @@ -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 */ public static final String COMBINATOR = SystemProperties.getString(WorkspaceList.class.getName(),"@"); } diff --git a/core/src/main/java/hudson/tasks/BatchFile.java b/core/src/main/java/hudson/tasks/BatchFile.java index 573f375e64fd..48d22cc0e1a6 100644 --- a/core/src/main/java/hudson/tasks/BatchFile.java +++ b/core/src/main/java/hudson/tasks/BatchFile.java @@ -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 */ @Restricted(Beta.class) @DataBoundSetter diff --git a/core/src/main/java/hudson/tasks/Shell.java b/core/src/main/java/hudson/tasks/Shell.java index 702b9897d3c1..8d5c385da320 100644 --- a/core/src/main/java/hudson/tasks/Shell.java +++ b/core/src/main/java/hudson/tasks/Shell.java @@ -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 */ @Restricted(Beta.class) @DataBoundSetter diff --git a/core/src/main/java/jenkins/fingerprints/FingerprintStorage.java b/core/src/main/java/jenkins/fingerprints/FingerprintStorage.java index 531817e03ca0..d92bbf4c22f3 100644 --- a/core/src/main/java/jenkins/fingerprints/FingerprintStorage.java +++ b/core/src/main/java/jenkins/fingerprints/FingerprintStorage.java @@ -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 */ public abstract void iterateAndCleanupFingerprints(TaskListener taskListener); /** * This method performs the cleanup of the given fingerprint. * - * @since TODO + * @since 2.246 */ public boolean cleanFingerprint(@NonNull Fingerprint fingerprint, TaskListener taskListener) { try { @@ -140,7 +140,7 @@ protected Fingerprint getFingerprint(Fingerprint fp) throws IOException { } /** - * @since TODO + * @since 2.246 */ @Override public FingerprintStorageDescriptor getDescriptor() { return (FingerprintStorageDescriptor) super.getDescriptor(); diff --git a/core/src/main/java/jenkins/model/labels/LabelValidator.java b/core/src/main/java/jenkins/model/labels/LabelValidator.java index d7f517ada60f..b04fb3ff2cb4 100644 --- a/core/src/main/java/jenkins/model/labels/LabelValidator.java +++ b/core/src/main/java/jenkins/model/labels/LabelValidator.java @@ -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 */ public interface LabelValidator extends ExtensionPoint { diff --git a/core/src/main/java/jenkins/tasks/SimpleBuildStep.java b/core/src/main/java/jenkins/tasks/SimpleBuildStep.java index 1db85c8cb83a..e9a1db3848dc 100644 --- a/core/src/main/java/jenkins/tasks/SimpleBuildStep.java +++ b/core/src/main/java/jenkins/tasks/SimpleBuildStep.java @@ -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 */ default void perform(@NonNull Run run, @NonNull FilePath workspace, @NonNull EnvVars env, @NonNull Launcher launcher, @NonNull TaskListener listener) throws InterruptedException, IOException { diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterException.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterException.java index 49c1fc136cb7..aa0ee0f2eb60 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterException.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterException.java @@ -32,7 +32,7 @@ /** * Exception that occurs during the environment filtering process, with helper to track the source. * - * @since TODO + * @since 2.246 */ @Restricted(Beta.class) public class EnvVarsFilterException extends AbortException { diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalConfiguration.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalConfiguration.java index 5f8008200533..f3f353017733 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalConfiguration.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalConfiguration.java @@ -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 */ @Extension @Symbol("envVarsFilter") diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalRule.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalRule.java index 4f1bd76110c1..c56ba1800fe9 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalRule.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterGlobalRule.java @@ -42,7 +42,7 @@ * * The local rules are applied before the global ones. * - * @since TODO + * @since 2.246 */ @Restricted(Beta.class) public interface EnvVarsFilterGlobalRule extends Describable, EnvVarsFilterRule, ExtensionPoint, Serializable { diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRule.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRule.java index eb31bab94275..bf812822c7e1 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRule.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRule.java @@ -37,7 +37,7 @@ * * The local rules are applied before the global ones. * - * @since TODO + * @since 2.246 */ @Restricted(Beta.class) public interface EnvVarsFilterLocalRule extends Describable, EnvVarsFilterRule, ExtensionPoint, Serializable { diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRuleDescriptor.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRuleDescriptor.java index 13812025831e..b5d2742db0dc 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRuleDescriptor.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterLocalRuleDescriptor.java @@ -38,7 +38,7 @@ * if the rule is applicable to a given builder and then applied every time.

* For global rule it's the inverse, the rule itself determines when it's applicable. * - * @since TODO + * @since 2.246 */ @Restricted(Beta.class) public abstract class EnvVarsFilterLocalRuleDescriptor extends Descriptor { diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleContext.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleContext.java index 325d32f3be24..18af8667373d 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleContext.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleContext.java @@ -32,7 +32,7 @@ /** * Information that is used for the environment filtering process. * - * @since TODO + * @since 2.246 */ @Restricted(Beta.class) public class EnvVarsFilterRuleContext { diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleWrapper.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleWrapper.java index 72d83298667c..4b94a968a6d3 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleWrapper.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterRuleWrapper.java @@ -40,7 +40,7 @@ /** * Helper class that provide the list of rules (local + global) for a given builder. * - * @since TODO + * @since 2.246 */ @Restricted(NoExternalUse.class) public class EnvVarsFilterRuleWrapper implements Serializable { diff --git a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterableBuilder.java b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterableBuilder.java index 001ead6a8460..221e066b531f 100644 --- a/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterableBuilder.java +++ b/core/src/main/java/jenkins/tasks/filters/EnvVarsFilterableBuilder.java @@ -33,7 +33,7 @@ /** * Builder step that wants to integrate local environment filter rules should implement this interface * - * @since TODO + * @since 2.246 */ @Restricted(Beta.class) public interface EnvVarsFilterableBuilder { diff --git a/core/src/main/java/jenkins/tasks/filters/impl/RetainVariablesLocalRule.java b/core/src/main/java/jenkins/tasks/filters/impl/RetainVariablesLocalRule.java index c0fed8d4ea81..752f93600a72 100644 --- a/core/src/main/java/jenkins/tasks/filters/impl/RetainVariablesLocalRule.java +++ b/core/src/main/java/jenkins/tasks/filters/impl/RetainVariablesLocalRule.java @@ -53,7 +53,7 @@ /** * Local rule that removes all the non-retained variables for that step. * - * @since TODO + * @since 2.246 */ @Restricted(NoExternalUse.class) public class RetainVariablesLocalRule implements EnvVarsFilterLocalRule { diff --git a/core/src/main/java/jenkins/util/SystemProperties.java b/core/src/main/java/jenkins/util/SystemProperties.java index 1916f94db3b1..908082fba89e 100644 --- a/core/src/main/java/jenkins/util/SystemProperties.java +++ b/core/src/main/java/jenkins/util/SystemProperties.java @@ -75,7 +75,7 @@ *

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 */ @SuppressFBWarnings(value = "ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD", justification = "Currently Jenkins instance may have one ond only one context") public class SystemProperties {