Noting deprecations more widely.

jenkinsci · Apr 11, 2015 · 37167d5 · 37167d5
1 parent 8dd079a
commit 37167d5
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 1 deletion.
diff --git a/core/src/main/java/hudson/DescriptorExtensionList.java b/core/src/main/java/hudson/DescriptorExtensionList.java
@@ -109,6 +109,7 @@ protected DescriptorExtensionList(Jenkins jenkins, Class<T> describableType) {
      *
      * @param fqcn
      *      Fully qualified name of the descriptor, not the describable.
+     * @deprecated {@link Descriptor#getId} is supposed to be used for new code, not the descriptor class name.
      */
     public D find(String fqcn) {
         return Descriptor.find(this,fqcn);

diff --git a/core/src/main/java/hudson/model/ComputerSet.java b/core/src/main/java/hudson/model/ComputerSet.java
@@ -289,7 +289,8 @@ public synchronized void doDoCreateItem( StaplerRequest req, StaplerResponse rsp
 
         JSONObject formData = req.getSubmittedForm();
         formData.put("name", fixedName);
-
+
+        // TODO type is probably NodeDescriptor.id but confirm
         Node result = NodeDescriptor.all().find(type).newInstance(req, formData);
         app.addNode(result);
 

diff --git a/core/src/main/java/hudson/model/Items.java b/core/src/main/java/hudson/model/Items.java
@@ -148,6 +148,9 @@ public static List<TopLevelItemDescriptor> all(Authentication a, ItemGroup c) {
         return result;
     }
 
+    /**
+     * @deprecated Underspecified what the parameter is. {@link Descriptor#getId}? A {@link Describable} class name?
+     */
     public static TopLevelItemDescriptor getDescriptor(String fqcn) {
         return Descriptor.find(all(), fqcn);
     }

diff --git a/core/src/main/java/hudson/tools/ToolLocationNodeProperty.java b/core/src/main/java/hudson/tools/ToolLocationNodeProperty.java
@@ -167,6 +167,7 @@ public String getHome() {
             return home;
         }
 
+        @SuppressWarnings("deprecation") // TODO this was mistakenly made to be the ToolDescriptor class name, rather than .id as you would expect; now baked into serial form
         public ToolDescriptor getType() {
             if (descriptor == null) {
                 descriptor = (ToolDescriptor) Descriptor.find(type);

diff --git a/core/src/main/java/hudson/util/DescriptorList.java b/core/src/main/java/hudson/util/DescriptorList.java
@@ -196,6 +196,7 @@ public void load(Class<? extends Describable> c) {
 
     /**
      * Finds the descriptor that has the matching fully-qualified class name.
+     * @deprecated Underspecified what the parameter is. {@link Descriptor#getId}? A {@link Describable} class name?
      */
     public Descriptor<T> find(String fqcn) {
         return Descriptor.find(this,fqcn);