-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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
Update at-since Javadoc #4877
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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) { | ||
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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) { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
public @CheckForNull | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(NoExternalUse.class) | ||
@Symbol("pluginDeprecation") | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(NoExternalUse.class) | ||
public boolean isDeprecated() { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@NonNull | ||
public FormValidation checkItem(@NonNull Item item, @NonNull Label label) { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@NonNull | ||
public static String idFor(@NonNull Class<?> clazz) { | ||
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@CheckForNull | ||
public static Downloadable get(@NonNull Class<?> clazz) { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1192,7 +1192,7 @@ public int size() { | |
/** | ||
* Returns the persisted facets. | ||
* | ||
* @since TODO | ||
* @since 2.242 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
public final @NonNull PersistedList<FingerprintFacet> 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -227,7 +227,7 @@ public ParameterValue getDefaultParameterValue() { | |
|
||
/** | ||
* Checks whether a given value is valid for this definition. | ||
* @since TODO | ||
* @since 2.244 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
*/ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -562,7 +562,7 @@ public final class Data { | |
/** | ||
* Mapping of plugin IDs to deprecation notices | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
private final Map<String, Deprecation> deprecations = new HashMap<>(); | ||
|
||
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(NoExternalUse.class) | ||
public Map<String, Deprecation> 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(NoExternalUse.class) | ||
public static final class Deprecation { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
public static final String COMBINATOR = SystemProperties.getString(WorkspaceList.class.getName(),"@"); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
@DataBoundSetter | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
@DataBoundSetter | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 { | ||
|
@@ -140,7 +140,7 @@ protected Fingerprint getFingerprint(Fingerprint fp) throws IOException { | |
} | ||
|
||
/** | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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(); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
public interface LabelValidator extends ExtensionPoint { | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ | |
/** | ||
* Exception that occurs during the environment filtering process, with helper to track the source. | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
public class EnvVarsFilterException extends AbortException { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Extension | ||
@Symbol("envVarsFilter") | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,7 +42,7 @@ | |
* | ||
* The local rules are applied before the global ones. | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
public interface EnvVarsFilterGlobalRule extends Describable<EnvVarsFilterGlobalRule>, EnvVarsFilterRule, ExtensionPoint, Serializable { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,7 +37,7 @@ | |
* | ||
* The local rules are applied before the global ones. | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
public interface EnvVarsFilterLocalRule extends Describable<EnvVarsFilterLocalRule>, EnvVarsFilterRule, ExtensionPoint, Serializable { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
public abstract class EnvVarsFilterLocalRuleDescriptor extends Descriptor<EnvVarsFilterLocalRule> { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ | |
/** | ||
* Information that is used for the environment filtering process. | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
public class EnvVarsFilterRuleContext { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,7 +40,7 @@ | |
/** | ||
* Helper class that provide the list of rules (local + global) for a given builder. | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(NoExternalUse.class) | ||
public class EnvVarsFilterRuleWrapper implements Serializable { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,7 +33,7 @@ | |
/** | ||
* Builder step that wants to integrate local environment filter rules should implement this interface | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(Beta.class) | ||
public interface EnvVarsFilterableBuilder { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -53,7 +53,7 @@ | |
/** | ||
* Local rule that removes all the non-retained variables for that step. | ||
* | ||
* @since TODO | ||
* @since 2.246 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
@Restricted(NoExternalUse.class) | ||
public class RetainVariablesLocalRule implements EnvVarsFilterLocalRule { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 { | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#4824