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

Fill in since annotations #137

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
16 changes: 8 additions & 8 deletions core/src/main/java/hudson/Functions.java
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ public static String addSuffix(int n, String singular, String plural) {
}

/**
* @since TODO
* @since 2.475
*/
public static RunUrl decompose(StaplerRequest2 req) {
List<Ancestor> ancestors = req.getAncestors();
Expand Down Expand Up @@ -610,7 +610,7 @@ public static <T> Iterable<T> reverse(Collection<T> collection) {
}

/**
* @since TODO
* @since 2.475
*/
public static Cookie getCookie(HttpServletRequest req, String name) {
Cookie[] cookies = req.getCookies();
Expand All @@ -633,7 +633,7 @@ public static javax.servlet.http.Cookie getCookie(javax.servlet.http.HttpServlet
}

/**
* @since TODO
* @since 2.475
*/
public static String getCookie(HttpServletRequest req, String name, String defaultValue) {
Cookie c = getCookie(req, name);
Expand Down Expand Up @@ -753,7 +753,7 @@ public static long getHourLocalTimezone() {
* This is used to determine the "current" URL assigned to the given object,
* so that one can compute relative URLs from it.
*
* @since TODO
* @since 2.475
*/
public static String getNearestAncestorUrl(StaplerRequest2 req, Object it) {
List list = req.getAncestors();
Expand Down Expand Up @@ -981,7 +981,7 @@ public static boolean hasPermission(Object object, Permission permission) throws
}

/**
* @since TODO
* @since 2.475
*/
public static void adminCheck(StaplerRequest2 req, StaplerResponse2 rsp, Object required, Permission permission) throws IOException, ServletException {
// this is legacy --- all views should be eventually converted to
Expand Down Expand Up @@ -1013,7 +1013,7 @@ public static void adminCheck(StaplerRequest req, StaplerResponse rsp, Object re
/**
* Infers the hudson installation URL from the given request.
*
* @since TODO
* @since 2.475
*/
public static String inferHudsonURL(StaplerRequest2 req) {
String rootUrl = Jenkins.get().getRootUrl();
Expand Down Expand Up @@ -2132,7 +2132,7 @@ public static List<Descriptor<CrumbIssuer>> getCrumbIssuerDescriptors() {
}

/**
* @since TODO
* @since 2.475
*/
public static String getCrumb(StaplerRequest2 req) {
Jenkins h = Jenkins.getInstanceOrNull();
Expand Down Expand Up @@ -2328,7 +2328,7 @@ public static String createRenderOnDemandProxy(JellyContext context, String attr
/**
* Called from renderOnDemand.jelly to generate the parameters for the proxy object generation.
*
* @since TODO
* @since 2.475
*/
@Restricted(NoExternalUse.class)
public static StaplerRequest2.RenderOnDemandParameters createRenderOnDemandProxyParameters(JellyContext context, String attributesToCapture) {
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/Plugin.java
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ public void configure(JSONObject formData) throws IOException, javax.servlet.Ser
* <p>
* If you are using this method, you'll likely be interested in
* using {@link #save()} and {@link #load()}.
* @since TODO
* @since 2.475
*/
public void configure(StaplerRequest2 req, JSONObject formData) throws IOException, ServletException, FormException {
try {
Expand All @@ -250,7 +250,7 @@ public void configure(StaplerRequest req, JSONObject formData) throws IOExceptio
/**
* This method serves static resources in the plugin under {@code hudson/plugin/SHORTNAME}.
*
* @since TODO
* @since 2.475
*/
public void doDynamic(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException {
if (Util.isOverridden(Plugin.class, getClass(), "doDynamic", StaplerRequest.class, StaplerResponse.class)) {
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 @@ -379,7 +379,7 @@ PluginManager doCreate(@NonNull Class<? extends PluginManager> klass,
private final PluginStrategy strategy;

/**
* @since TODO
* @since 2.475
*/
protected PluginManager(ServletContext context, File rootDir) {
this.context = context;
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/Util.java
Original file line number Diff line number Diff line change
Expand Up @@ -1852,7 +1852,7 @@ public static long daysElapsedSince(@NonNull Date date) {
* Find the specific ancestor, or throw an exception.
* Useful for an ancestor we know is inside the URL to ease readability
*
* @since TODO
* @since 2.475
*/
@Restricted(NoExternalUse.class)
public static @NonNull <T> T getNearestAncestorOfTypeOrThrow(@NonNull StaplerRequest2 request, @NonNull Class<T> clazz) {
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/WebAppMain.java
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ private void recordBootAttempt(File home) {
}

/**
* @since TODO
* @since 2.475
*/
public static void installExpressionFactory(ServletContextEvent event) {
JellyFacet.setExpressionFactory(event, new ExpressionFactory2());
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/hudson/console/AnnotatedLargeText.java
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public AnnotatedLargeText(ByteBuffer memory, Charset charset, boolean completed,
}

/**
* @since TODO
* @since 2.475
*/
public void doProgressiveHtml(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException {
if (Util.isOverridden(AnnotatedLargeText.class, getClass(), "doProgressiveHtml", StaplerRequest.class, StaplerResponse.class)) {
Expand All @@ -122,7 +122,7 @@ private void doProgressiveHtmlImpl(StaplerRequest2 req, StaplerResponse2 rsp) th
/**
* Aliasing what I think was a wrong name in {@link LargeText}
*
* @since TODO
* @since 2.475
*/
public void doProgressiveText(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException {
doProgressText(req, rsp);
Expand All @@ -146,7 +146,7 @@ private boolean isHtml() {
}

/**
* @since TODO
* @since 2.475
*/
@Override
protected void setContentType(StaplerResponse2 rsp) {
Expand Down
8 changes: 4 additions & 4 deletions core/src/main/java/hudson/model/AbstractItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,7 @@ private Object readResolve() {
/**
* Accepts the new description.
*
* @since TODO
* @since 2.475
*/
@RequirePOST
public synchronized void doSubmitDescription(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException {
Expand Down Expand Up @@ -690,7 +690,7 @@ private void doSubmitDescriptionImpl(StaplerRequest2 req, StaplerResponse2 rsp)
* since it predates {@code <l:confirmationLink>}. {@code /delete} goes to a Jelly page
* which should now be unused by core but is left in case plugins are still using it.
*
* @since TODO
* @since 2.475
*/
@RequirePOST
public void doDoDelete(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException, InterruptedException {
Expand Down Expand Up @@ -736,7 +736,7 @@ private void doDoDeleteImpl(StaplerRequest2 req, StaplerResponse2 rsp) throws IO
}

/**
* @since TODO
* @since 2.475
*/
@Override
public void delete(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException {
Expand Down Expand Up @@ -830,7 +830,7 @@ protected void performDelete() throws IOException, InterruptedException {
/**
* Accepts {@code config.xml} submission, as well as serve it.
*
* @since TODO
* @since 2.475
*/
@WebMethod(name = "config.xml")
public void doConfigDotXml(StaplerRequest2 req, StaplerResponse2 rsp)
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 @@ -1778,7 +1778,7 @@ public void doPolling(StaplerRequest2 req, StaplerResponse2 rsp) throws IOExcept
}

/**
* @since TODO
* @since 2.475
*/
@Override
protected void submit(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException, FormException {
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/model/Actionable.java
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ public <T extends Action> T getAction(Class<T> type) {
}

/**
* @since TODO
* @since 2.475
*/
public Object getDynamic(String token, StaplerRequest2 req, StaplerResponse2 rsp) {
if (Util.isOverridden(Actionable.class, getClass(), "getDynamic", String.class, StaplerRequest.class, StaplerResponse.class)) {
Expand Down Expand Up @@ -374,7 +374,7 @@ private Object getDynamicImpl(String token, StaplerRequest2 req, StaplerResponse
}

/**
* @since TODO
* @since 2.475
*/
@Override
public ContextMenu doContextMenu(StaplerRequest2 request, StaplerResponse2 response) throws Exception {
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/model/BuildAuthorizationToken.java
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public BuildAuthorizationToken(String token) {
}

/**
* @since TODO
* @since 2.475
*/
public static BuildAuthorizationToken create(StaplerRequest2 req) {
if (req.getParameter("pseudoRemoteTrigger") != null) {
Expand All @@ -79,7 +79,7 @@ public static BuildAuthorizationToken create(StaplerRequest req) {
}

/**
* @since TODO
* @since 2.475
*/
public static void checkPermission(Job<?, ?> project, BuildAuthorizationToken token, StaplerRequest2 req, StaplerResponse2 rsp) throws IOException {
if (token != null && token.token != null) {
Expand Down
12 changes: 6 additions & 6 deletions core/src/main/java/hudson/model/Descriptor.java
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ public T newInstance(StaplerRequest req) throws FormException {
*
* @throws FormException
* Signals a problem in the submitted form.
* @since TODO
* @since 2.475
*/
public T newInstance(@Nullable StaplerRequest2 req, @NonNull JSONObject formData) throws FormException {
if (Util.isOverridden(Descriptor.class, getClass(), "newInstance", StaplerRequest.class, JSONObject.class)) {
Expand Down Expand Up @@ -626,7 +626,7 @@ private T newInstanceImpl(@Nullable StaplerRequest2 req, @NonNull JSONObject for
* Replacement for {@link StaplerRequest2#bindJSON(Class, JSONObject)} which honors {@link #newInstance(StaplerRequest2, JSONObject)}.
* This is automatically used inside {@link #newInstance(StaplerRequest2, JSONObject)} so a direct call would only be necessary
* in case the top level binding might use a {@link Descriptor} which overrides {@link #newInstance(StaplerRequest2, JSONObject)}.
* @since TODO
* @since 2.475
*/
public static <T> T bindJSON(StaplerRequest2 req, Class<T> type, JSONObject src) {
return bindJSON(req, type, src, false);
Expand Down Expand Up @@ -859,7 +859,7 @@ public boolean configure(StaplerRequest req) throws FormException {
* See <a href="https://www.jenkins.io/doc/developer/forms/structured-form-submission/">the developer documentation</a>.
* @return false
* to keep the client in the same config page.
* @since TODO
* @since 2.475
*/
public boolean configure(StaplerRequest2 req, JSONObject json) throws FormException {
if (Util.isOverridden(Descriptor.class, getClass(), "configure", StaplerRequest.class, JSONObject.class)) {
Expand Down Expand Up @@ -1062,7 +1062,7 @@ private void doHelpImpl(StaplerRequest2 req, StaplerResponse2 rsp) throws IOExce
}

/**
* @since TODO
* @since 2.475
*/
@Restricted(NoExternalUse.class)
public static URL getStaticHelpUrl(StaplerRequest2 req, Klass<?> c, String suffix) {
Expand Down Expand Up @@ -1142,7 +1142,7 @@ Map<Descriptor<T>, T> toMap(Iterable<T> describables) {
* List of descriptors to create instances from.
* @return
* Can be empty but never null.
* @since TODO
* @since 2.475
*/
public static <T extends Describable<T>>
List<T> newInstancesFromHeteroList(StaplerRequest2 req, JSONObject formData, String key,
Expand All @@ -1162,7 +1162,7 @@ List<T> newInstancesFromHeteroList(StaplerRequest req, JSONObject formData, Stri
}

/**
* @since TODO
* @since 2.475
*/
public static <T extends Describable<T>>
List<T> newInstancesFromHeteroList(StaplerRequest2 req, Object formData,
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/model/Hudson.java
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public static Hudson getInstance() {
}

/**
* @since TODO
* @since 2.475
*/
public Hudson(File root, ServletContext context) throws IOException, InterruptedException, ReactorException {
this(root, context, null);
Expand All @@ -96,7 +96,7 @@ public Hudson(File root, javax.servlet.ServletContext context) throws IOExceptio
}

/**
* @since TODO
* @since 2.475
*/
public Hudson(File root, ServletContext context, PluginManager pluginManager) throws IOException, InterruptedException, ReactorException {
super(root, context, pluginManager);
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/model/ItemGroupMixIn.java
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ public static <K, V extends Item> Map<K, V> loadChildren(ItemGroup parent, File
* Creates a {@link TopLevelItem} for example from the submission of the {@code /lib/hudson/newFromList/form} tag
* or throws an exception if it fails.
*
* @since TODO
* @since 2.475
*/
public synchronized TopLevelItem createTopLevelItem(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException {
acl.checkPermission(Item.CREATE);
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/hudson/model/Job.java
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,7 @@ public RunT getNearestOldBuild(int n) {
}

/**
* @since TODO
* @since 2.475
*/
@Override
public Object getDynamic(String token, StaplerRequest2 req,
Expand Down Expand Up @@ -1207,7 +1207,7 @@ public String getEntryAuthor(FeedItem entry) {


/**
* @since TODO
* @since 2.475
*/
@Override
public ContextMenu doChildrenContextMenu(StaplerRequest2 request, StaplerResponse2 response) throws Exception {
Expand Down Expand Up @@ -1433,7 +1433,7 @@ public synchronized void doConfigSubmit(StaplerRequest2 req,
* Derived class can override this to perform additional config submission
* work.
*
* @since TODO
* @since 2.475
*/
protected void submit(StaplerRequest2 req, StaplerResponse2 rsp)
throws IOException, ServletException, FormException {
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/model/JobProperty.java
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ public Collection<?> getJobOverrides() {
}

/**
* @since TODO
* @since 2.475
*/
@Override
public JobProperty<?> reconfigure(StaplerRequest2 req, JSONObject form) throws FormException {
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/hudson/model/Project.java
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public MavenInstallation inferMavenInstallation() {
//

/**
* @since TODO
* @since 2.475
*/
@Override
protected void submit(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException, FormException {
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/hudson/model/RSS.java
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public final class RSS {
* Entries to be listed in the RSS feed.
* @param adapter
* Controls how to render entries to RSS.
* @since TODO
* @since 2.475
*/
public static <E> void forwardToRss(String title, String url, Collection<? extends E> entries, FeedAdapter<E> adapter, StaplerRequest2 req, HttpServletResponse rsp) throws IOException, ServletException {
req.setAttribute("adapter", adapter);
Expand Down Expand Up @@ -98,7 +98,7 @@ public static <E> void forwardToRss(String title, String url, Collection<? exten
* URL of the model object that owns this feed. Relative to the context root.
* @param runList
* Entries to be listed in the RSS feed.
* @since TODO
* @since 2.475
*/
public static void rss(StaplerRequest2 req, StaplerResponse2 rsp, String title, String url, RunList runList) throws IOException, ServletException {
rss(req, rsp, title, url, runList, null);
Expand Down Expand Up @@ -128,7 +128,7 @@ public static void rss(StaplerRequest req, StaplerResponse rsp, String title, St
* Entries to be listed in the RSS feed.
* @param feedAdapter
* Controls how to render entries to RSS.
* @since TODO
* @since 2.475
*/
public static void rss(StaplerRequest2 req, StaplerResponse2 rsp, String title, String url, RunList runList, FeedAdapter<Run> feedAdapter) throws IOException, ServletException {
final FeedAdapter<Run> feedAdapter_ = feedAdapter == null ? Run.FEED_ADAPTER : feedAdapter;
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/hudson/model/Run.java
Original file line number Diff line number Diff line change
Expand Up @@ -2297,7 +2297,7 @@ public void doBuildTimestamp(StaplerRequest2 req, StaplerResponse2 rsp, @QueryPa
/**
* Sends out the raw console output.
*
* @since TODO
* @since 2.475
*/
public void doConsoleText(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException {
if (Util.isOverridden(Run.class, getClass(), "doConsoleText", StaplerRequest.class, StaplerResponse.class)) {
Expand Down Expand Up @@ -2375,7 +2375,7 @@ public void keepLog(boolean newValue) throws IOException {
/**
* Deletes the build when the button is pressed.
*
* @since TODO
* @since 2.475
*/
@RequirePOST
public void doDoDelete(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException {
Expand Down
Loading