提交 21e3b3ec 编写于 作者: M mindless

Add "since .." on deprecated things


git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@21863 71c3de6d-444a-0410-be80-ed276b4c234a
上级 d3b5cde1
......@@ -138,7 +138,7 @@ public class ExtensionList<T> extends AbstractList<T> {
/**
* Write access will put the instance into a legacy store.
*
* @deprecated
* @deprecated since 2009-02-23.
* Prefer automatic registration.
*/
@Override
......
......@@ -118,7 +118,7 @@ public abstract class Launcher {
*
* @return
* null if this launcher is not created from a {@link Computer} object.
* @deprecated
* @deprecated since 2008-11-16.
* See the javadoc for why this is inherently unreliable. If you are trying to
* figure out the current {@link Computer} from within a build, use
* {@link Computer#currentComputer()}
......
......@@ -975,7 +975,7 @@ public class Util {
* but don't remember it right now.
*
* @since 1.204
* @deprecated This method is broken (see ISSUE#1666). It should probably
* @deprecated since 2008-05-13. This method is broken (see ISSUE#1666). It should probably
* be removed but I'm not sure if it is considered part of the public API
* that needs to be maintained for backwards compatibility.
* Use {@link #encode(String)} instead.
......
......@@ -167,7 +167,7 @@ public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends A
private volatile String jdk;
/**
* @deprecated
* @deprecated since 2007-01-29.
*/
private transient boolean enableRemoteTrigger;
......
......@@ -36,7 +36,7 @@ import java.io.IOException;
*
* @author Kohsuke Kawaguchi
* @see BuildableItem
* @deprecated
* @deprecated 2008-07-20
* Use {@link ACL} and {@link AbstractProject#BUILD}. This code is only here
* for the backward compatibility.
*/
......
......@@ -58,6 +58,7 @@ public abstract class Cause {
/**
* Fall back implementation when no other type is available.
* @deprecated since 2009-02-08
*/
public static class LegacyCodeCause extends Cause {
private StackTraceElement [] stackTrace;
......@@ -77,10 +78,16 @@ public abstract class Cause {
public static class UpstreamCause extends Cause {
private String upstreamProject, upstreamUrl;
private int upstreamBuild;
/**
* @deprecated since 2009-02-28
*/
@Deprecated
private transient Cause upstreamCause;
private List<Cause> upstreamCauses;
/**
* @deprecated since 2009-02-28
*/
// for backward bytecode compatibility
public UpstreamCause(AbstractBuild<?,?> up) {
this((Run<?,?>)up);
......
......@@ -33,9 +33,12 @@ import org.kohsuke.stapler.export.ExportedBean;
@ExportedBean
public class CauseAction implements FoldableAction {
@Deprecated
// there can be multiple causes, so this is deprecated
private transient Cause cause;
/**
* @deprecated since 2009-02-28
*/
@Deprecated
// there can be multiple causes, so this is deprecated
private transient Cause cause;
private List<Cause> causes = new ArrayList<Cause>();
......
......@@ -209,7 +209,7 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
public abstract void doLaunchSlaveAgent( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException;
/**
* @deprecated Use {@link #connect(boolean)}
* @deprecated since 2009-01-06. Use {@link #connect(boolean)}
*/
public final void launch() {
connect(true);
......@@ -393,7 +393,8 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
/**
* Returns true if this computer is supposed to be launched via JNLP.
* @deprecated see {@linkplain #isLaunchSupported()} and {@linkplain ComputerLauncher}
* @deprecated since 2008-05-18.
* See {@linkplain #isLaunchSupported()} and {@linkplain ComputerLauncher}
*/
@Exported
@Deprecated
......
......@@ -119,7 +119,7 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable {
* Going forward Hudson simply persists all the non-transient fields
* of {@link Descriptor}, just like others, so this is pointless.
*
* @deprecated
* @deprecated since 2006-11-16
*/
@Deprecated
private transient Map<String,Object> properties;
......@@ -687,4 +687,4 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable {
throw new AssertionError();
}
}
}
\ No newline at end of file
}
......@@ -73,8 +73,8 @@ public final class DirectoryBrowserSupport implements HttpResponse {
private String indexFileName = "index.html";
/**
* @deprecated
* Use {@link #DirectoryBrowserSupport(ModelObject, String)}
* @deprecated since 2007-08-12.
* Use {@link #DirectoryBrowserSupport(ModelObject, FilePath, String, String, boolean)}
*/
public DirectoryBrowserSupport(ModelObject owner) {
this(owner,owner.getDisplayName());
......
......@@ -44,7 +44,7 @@ import java.util.concurrent.ConcurrentHashMap;
public final class FingerprintMap extends KeyedDataStorage<Fingerprint,FingerprintParams> {
/**
* @deprecated
* @deprecated since 2007-03-26.
* Some old version of Hudson incorrectly serialized this information to the disk.
* So we need this field to be here for such configuration to be read correctly.
* This field is otherwise no longer in use.
......
......@@ -70,7 +70,7 @@ public class HealthReport implements Serializable, Comparable<HealthReport> {
/**
* Recover the health icon's tool-tip when deserializing.
*
* @deprecated use {@link #localizibleDescription}
* @deprecated since 2008-10-18. Use {@link #localizibleDescription}
*/
@Deprecated
private transient String description;
......@@ -93,7 +93,8 @@ public class HealthReport implements Serializable, Comparable<HealthReport> {
* When calculating the url to display for absolute paths, the getIconUrl(String) method
* will replace /32x32/ in the path with the appropriate size.
* @param description The health icon's tool-tip.
* @deprecated use {@link #HealthReport(int, String, org.jvnet.localizer.Localizable)}
* @deprecated since 2008-10-18.
* Use {@link #HealthReport(int, String, org.jvnet.localizer.Localizable)}
*/
@Deprecated
public HealthReport(int score, String iconUrl, String description) {
......@@ -140,7 +141,8 @@ public class HealthReport implements Serializable, Comparable<HealthReport> {
*
* @param score The percentage health score (from 0 to 100 inclusive).
* @param description The health icon's tool-tip.
* @deprecated use {@link #HealthReport(int, org.jvnet.localizer.Localizable)}
* @deprecated since 2008-10-18.
* Use {@link #HealthReport(int, org.jvnet.localizer.Localizable)}
*/
@Deprecated
public HealthReport(int score, String description) {
......
......@@ -861,7 +861,7 @@ public final class Hudson extends Node implements ItemGroup<TopLevelItem>, Stapl
/**
* Adds a new {@link JobListener}.
*
* @deprecated
* @deprecated since 2007-01-04.
* Use {@code getJobListeners().add(l)} instead.
*/
public void addListener(JobListener l) {
......@@ -871,7 +871,7 @@ public final class Hudson extends Node implements ItemGroup<TopLevelItem>, Stapl
/**
* Deletes an existing {@link JobListener}.
*
* @deprecated
* @deprecated since 2007-01-04.
* Use {@code getJobListeners().remove(l)} instead.
*/
public boolean removeListener(JobListener l ) {
......@@ -3257,7 +3257,7 @@ public final class Hudson extends Node implements ItemGroup<TopLevelItem>, Stapl
}
/**
* @deprecated
* @deprecated since 2007-12-18.
* Use {@link #checkPermission(Permission)}
*/
public static boolean adminCheck() throws IOException {
......@@ -3265,7 +3265,7 @@ public final class Hudson extends Node implements ItemGroup<TopLevelItem>, Stapl
}
/**
* @deprecated
* @deprecated since 2007-12-18.
* Use {@link #checkPermission(Permission)}
*/
public static boolean adminCheck(StaplerRequest req,StaplerResponse rsp) throws IOException {
......@@ -3279,7 +3279,7 @@ public final class Hudson extends Node implements ItemGroup<TopLevelItem>, Stapl
* Checks if the current user (for which we are processing the current request)
* has the admin access.
*
* @deprecated
* @deprecated since 2007-12-18.
* This method is deprecated when Hudson moved from simple Unix root-like model
* of "admin gets to do everything, and others don't have any privilege" to more
* complex {@link ACL} and {@link Permission} based scheme.
......@@ -3298,7 +3298,7 @@ public final class Hudson extends Node implements ItemGroup<TopLevelItem>, Stapl
}
/**
* @deprecated
* @deprecated since 2007-12-18.
* Define a custom {@link Permission} and check against ACL.
* See {@link #isAdmin()} for more instructions.
*/
......
......@@ -51,6 +51,9 @@ import org.kohsuke.stapler.QueryParameter;
* @author Kohsuke Kawaguchi
*/
public final class JDK extends ToolInstallation implements NodeSpecific<JDK>, EnvironmentSpecific<JDK> {
/**
* @deprecated since 2009-02-25
*/
@Deprecated // kept for backward compatibility - use getHome() instead
private String javaHome;
......
......@@ -570,8 +570,8 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
}
/**
* @deprecated This is only used to support backward compatibility with old
* URLs.
* @deprecated since 2008-06-15.
* This is only used to support backward compatibility with old URLs.
*/
@Deprecated
public RunT getBuild(String id) {
......
......@@ -32,6 +32,7 @@ import java.util.List;
* List of all installed {@link Job} types.
*
* @author Kohsuke Kawaguchi
* @deprecated since 1.281
*/
public class Jobs {
/**
......
......@@ -102,7 +102,7 @@ public class MultiStageTimeSeries {
}
/**
* @deprecated
* @deprecated since 2009-04-05.
* Use {@link #MultiStageTimeSeries(Localizable, Color, float, float)}
*/
public MultiStageTimeSeries(float initialValue, float decay) {
......
......@@ -161,7 +161,7 @@ public abstract class ParameterValue implements Serializable {
/**
* Accessing {@link ParameterDefinition} is not a good idea.
*
* @deprecated
* @deprecated since 2008-09-20.
* parameter definition may change any time. So if you find yourself
* in need of accessing the information from {@link ParameterDefinition},
* instead copy them in {@link ParameterDefinition#createValue(StaplerRequest, JSONObject)}
......
......@@ -227,8 +227,8 @@ public abstract class Project<P extends Project<P,B>,B extends Build<P,B>>
}
/**
* @deprecated
* left for legacy config file compatibility
* @deprecated since 2006-11-05.
* Left for legacy config file compatibility
*/
@Deprecated
private transient String slave;
......
......@@ -1259,8 +1259,9 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
/**
* Gets the log of the build as a string.
*
* @deprecated Use {@link #getLog(int)} instead as it avoids loading
* the whole log into memory unnecessarily.
* @deprecated since 2007-11-11.
* Use {@link #getLog(int)} instead as it avoids loading
* the whole log into memory unnecessarily.
*/
@Deprecated
public String getLog() throws IOException {
......
......@@ -130,6 +130,9 @@ public abstract class Slave extends Node implements Serializable {
this(name,nodeDescription,remoteFS,Util.tryParseNumber(numExecutors, 1).intValue(),mode,labelString,launcher,retentionStrategy, nodeProperties);
}
/**
* @deprecated since 2009-02-20.
*/
@Deprecated
public Slave(String name, String nodeDescription, String remoteFS, int numExecutors,
Mode mode, String labelString, ComputerLauncher launcher, RetentionStrategy retentionStrategy) throws FormException, IOException {
......@@ -395,6 +398,7 @@ public abstract class Slave extends Node implements Serializable {
* @deprecated
*/
private transient String command;
/**
* Command line to launch the agent, like
* "ssh myslave java -jar /path/to/hudson-remoting.jar"
......
......@@ -80,7 +80,7 @@ public abstract class TopLevelItemDescriptor extends Descriptor<TopLevelItem> {
}
/**
* @deprecated
* @deprecated since 2007-01-19.
* This is not a valid operation for {@link Job}s.
*/
@Deprecated
......
......@@ -36,7 +36,8 @@ import hudson.ExtensionPoint;
*
* @author Kohsuke Kawaguchi
* @see Hudson#addListener(JobListener)
* @deprecated {@link ItemListener} is the generalized form of this.
* @deprecated since 2007-10-09.
* {@link ItemListener} is the generalized form of this.
*/
public abstract class JobListener implements ExtensionPoint {
/**
......@@ -46,8 +47,7 @@ public abstract class JobListener implements ExtensionPoint {
}
/**
* Called after all the jobs are loaded from disk into {@link Hudson}
* object.
* Called after all the jobs are loaded from disk into {@link Hudson} object.
*
* @since 1.68
*/
......
......@@ -99,7 +99,7 @@ public abstract class RunListener<R extends Run> implements ExtensionPoint {
* Registers this object as an active listener so that it can start getting
* callbacks invoked.
*
* @deprecated
* @deprecated as of 1.281
* Put {@link Extension} on your class to get it auto-registered.
*/
public void register() {
......
......@@ -65,7 +65,7 @@ public class RepositoryBrowsers {
/**
* Creates an instance of {@link RepositoryBrowser} from a form submission.
*
* @deprecated
* @deprecated since 2008-06-19.
* Use {@link #createInstance(Class, StaplerRequest, JSONObject, String)}.
*/
public static <T extends RepositoryBrowser>
......
......@@ -78,9 +78,10 @@ public abstract class AuthorizationStrategy implements Describable<Authorization
public abstract ACL getRootACL();
/**
* @deprecated
* @deprecated since 1.277
* Override {@link #getACL(Job)} instead.
*/
@Deprecated
public ACL getACL(AbstractProject<?,?> project) {
return getACL((Job)project);
}
......@@ -188,7 +189,7 @@ public abstract class AuthorizationStrategy implements Describable<Authorization
/**
* All registered {@link SecurityRealm} implementations.
*
* @deprecated
* @deprecated since 1.286
* Use {@link #all()} for read access, and {@link Extension} for registration.
*/
public static final DescriptorList<AuthorizationStrategy> LIST = new DescriptorList<AuthorizationStrategy>(AuthorizationStrategy.class);
......
......@@ -222,7 +222,7 @@ public final class Permission {
/**
* {@link PermissionGroup} for {@link Hudson}.
*
* @deprecated
* @deprecated since 2009-01-23.
* Access {@link Hudson#PERMISSIONS} instead.
*/
public static final PermissionGroup HUDSON_PERMISSIONS = new PermissionGroup(Hudson.class, hudson.model.Messages._Hudson_Permissions_Title());
......@@ -232,7 +232,7 @@ public final class Permission {
* <p>
* All permissions are eventually {@linkplain Permission#impliedBy implied by} this permission.
*
* @deprecated
* @deprecated since 2009-01-23.
* Access {@link Hudson#ADMINISTER} instead.
*/
public static final Permission HUDSON_ADMINISTER = new Permission(HUDSON_PERMISSIONS,"Administer", hudson.model.Messages._Hudson_AdministerPermission_Description(),null);
......@@ -251,7 +251,7 @@ public final class Permission {
* Historically this was separate from {@link #HUDSON_ADMINISTER} but such a distinction doesn't make sense
* any more, so deprecated.
*
* @deprecated
* @deprecated since 2009-01-23.
* Use {@link Hudson#ADMINISTER}.
*/
public static final Permission FULL_CONTROL = new Permission(GROUP,"FullControl",HUDSON_ADMINISTER);
......
......@@ -56,7 +56,7 @@ import java.util.logging.Logger;
*/
public class Channels {
/**
* @deprecated
* @deprecated since 2009-04-13.
* Use {@link #forProcess(String, ExecutorService, InputStream, OutputStream, OutputStream, Proc)}
*/
public static Channel forProcess(String name, ExecutorService execService, InputStream in, OutputStream out, Proc proc) throws IOException {
......
......@@ -144,8 +144,10 @@ public class SlaveComputer extends Computer {
return super.getIcon();
}
@Override
@Deprecated
/**
* @deprecated since 2008-05-20.
*/
@Deprecated @Override
public boolean isJnlpAgent() {
return launcher instanceof JNLPLauncher;
}
......@@ -406,7 +408,7 @@ public class SlaveComputer extends Computer {
/**
* Serves jar files for JNLP slave agents.
*
* @deprecated
* @deprecated since 2008-08-18.
* This URL binding is no longer used and moved up directly under to {@link Hudson},
* but it's left here for now just in case some old JNLP slave agents request it.
*/
......
......@@ -41,6 +41,7 @@ import java.io.IOException;
*
* @author Kohsuke Kawaguchi
* @since 1.150
* @deprecated since 1.150
*/
public abstract class BuildStepCompatibilityLayer implements BuildStep {
//
......
......@@ -97,9 +97,10 @@ public abstract class BuildWrapper implements ExtensionPoint, Describable<BuildW
}
/**
* @deprecated
* @deprecated since 2007-10-28.
* Use {@link #tearDown(AbstractBuild, BuildListener)} instead.
*/
@Deprecated
public boolean tearDown( Build build, BuildListener listener ) throws IOException, InterruptedException {
return true;
}
......@@ -135,9 +136,10 @@ public abstract class BuildWrapper implements ExtensionPoint, Describable<BuildW
}
/**
* @deprecated
* @deprecated since 2007-10-28.
* Use {@link #setUp(AbstractBuild, Launcher, BuildListener)} instead.
*/
@Deprecated
public Environment setUp( Build build, Launcher launcher, BuildListener listener ) throws IOException, InterruptedException {
throw new UnsupportedOperationException(getClass()+" needs to implement the setUp method");
}
......
......@@ -345,6 +345,9 @@ public class Maven extends Builder {
*/
public static final class MavenInstallation extends ToolInstallation implements EnvironmentSpecific<MavenInstallation>, NodeSpecific<MavenInstallation> {
/**
* @deprecated since 2009-02-25.
*/
@Deprecated // kept for backward compatiblity - use getHome()
private String mavenHome;
......
......@@ -76,18 +76,18 @@ public abstract class Publisher extends BuildStepCompatibilityLayer implements B
//
/**
* Default implementation that does nothing.
* @deprecated since 1.150
*/
@Deprecated
@Override
@Deprecated @Override
public boolean prebuild(Build build, BuildListener listener) {
return true;
}
/**
* Default implementation that does nothing.
* @deprecated since 1.150
*/
@Deprecated
@Override
@Deprecated @Override
public Action getProjectAction(Project project) {
return null;
}
......
......@@ -89,7 +89,7 @@ public abstract class UserNameResolver implements ExtensionPoint {
/**
* All registered {@link UserNameResolver} implementations.
*
* @deprecated
* @deprecated since 2009-02-24.
* Use {@link #all()} for read access, and use {@link Extension} for registration.
*/
public static final List<UserNameResolver> LIST = ExtensionListView.createList(UserNameResolver.class);
......
......@@ -88,6 +88,7 @@ public class JUnitResultArchiver extends Recorder implements Serializable,
/**
* left for backwards compatibility
* @deprecated since 2009-08-09.
*/
@Deprecated
public JUnitResultArchiver(String testResults) {
......@@ -161,7 +162,7 @@ public class JUnitResultArchiver extends Recorder implements Serializable,
/**
* Not actually used, but left for backward compatibility
*
* @deprecated
* @deprecated since 2009-08-10.
*/
protected TestResult parseResult(DirectoryScanner ds, long buildTime)
throws IOException {
......
......@@ -83,8 +83,8 @@ public class ToolLocationNodeProperty extends NodeProperty<Node> {
*
* @return
* never null.
* @deprecated
* Use {@link ToolInstallation#translateFor(Node)}
* @deprecated since 2009-04-09.
* Use {@link ToolInstallation#translateFor(Node,TaskListener)}
*/
public static String getToolHome(Node node, ToolInstallation installation, TaskListener log) throws IOException, InterruptedException {
String result = null;
......
......@@ -35,7 +35,7 @@ import java.io.InputStream;
* This version allows one to read while writing is in progress.
*
* @author Kohsuke Kawaguchi
* @deprecated Moved to stapler
* @deprecated since 2008-05-28. Moved to stapler
*/
public class ByteBuffer extends OutputStream {
private byte[] buf = new byte[8192];
......
......@@ -32,7 +32,7 @@ import java.util.List;
* {@link Writer} that spools the output and writes to another {@link Writer} later.
*
* @author Kohsuke Kawaguchi
* @deprecated moved to stapler
* @deprecated since 2008-05-28. moved to stapler
*/
public final class CharSpool extends Writer {
private List<char[]> buf;
......
......@@ -69,7 +69,7 @@ public class DescribableList<T extends Describable<T>, D extends Descriptor<T>>
}
/**
* @deprecated
* @deprecated since 2008-08-15.
* Use {@link #DescribableList(Saveable)}
*/
public DescribableList(Owner owner) {
......@@ -81,7 +81,7 @@ public class DescribableList<T extends Describable<T>, D extends Descriptor<T>>
}
/**
* @deprecated
* @deprecated since 2008-08-15.
* Use {@link #setOwner(Saveable)}
*/
public void setOwner(Owner owner) {
......@@ -279,7 +279,7 @@ public class DescribableList<T extends Describable<T>, D extends Descriptor<T>>
}
/**
* @deprecated
* @deprecated since 2008-08-15.
* Just implement {@link Saveable}.
*/
public interface Owner extends Saveable {
......
......@@ -37,7 +37,7 @@ import java.io.IOException;
* we use this filter to always convert LF to CR+LF.
*
* @author Kohsuke Kawaguchi
* @deprecated moved to stapler
* @deprecated since 2008-05-28. moved to stapler
*/
public class LineEndNormalizingWriter extends FilterWriter {
......
......@@ -38,7 +38,7 @@ import java.nio.*;
* by assuming the platform default encoding.
*
* @author Kohsuke Kawaguchi
* @deprecated
* @deprecated since 2008-05-28.
* Use the one in stapler.
*/
public class WriterOutputStream extends OutputStream {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册