Package hudson

Class StructuredForm

java.lang.Object
hudson.StructuredForm
public class StructuredForm extends Object
Obtains the structured form data from StaplerRequest. See the developer documentation.
Author:
Kohsuke Kawaguchi

  • Constructor Summary

    Constructors
    Constructor
    Description
    StructuredForm()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static net.sf.json.JSONObject
    get(org.kohsuke.stapler.StaplerRequest req)
    Deprecated.
    Use StaplerRequest.getSubmittedForm().
    static List<net.sf.json.JSONObject>
    toList(net.sf.json.JSONObject parent, String propertyName)
    Retrieves the property of the given object and returns it as a list of JSONObject.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • StructuredForm

      public StructuredForm()

  • Method Details

    • get

      @Deprecated public static net.sf.json.JSONObject get(org.kohsuke.stapler.StaplerRequest req) throws javax.servlet.ServletException
      Deprecated.
      Use StaplerRequest.getSubmittedForm(). Since 1.238.
      Throws:
      javax.servlet.ServletException

    • toList

      public static List<net.sf.json.JSONObject> toList(net.sf.json.JSONObject parent, String propertyName)
      Retrieves the property of the given object and returns it as a list of JSONObject.

      If the value doesn't exist, this method returns an empty list. If the value is a JSONObject, this method will return a singleton list. If it's a JSONArray, the contents will be returned as a list.

      Because of the way structured form submission work, this is convenient way of handling repeated multi-value entries.

      Since:
      1.233