Package hudson.model

Class AutoCompletionCandidates

  • All Implemented Interfaces:
    org.kohsuke.stapler.HttpResponse

    public class AutoCompletionCandidates
    extends Object
    implements org.kohsuke.stapler.HttpResponse
    Data representation of the auto-completion candidates.

    This object should be returned from your doAutoCompleteXYZ methods.

    Author:
    Kohsuke Kawaguchi
    • Constructor Detail

      • AutoCompletionCandidates

        public AutoCompletionCandidates()
    • Method Detail

      • getValues

        public List<String> getValues()
        Exposes the raw value, in case you want to modify List directly.
        Since:
        1.402
      • generateResponse

        public void generateResponse​(org.kohsuke.stapler.StaplerRequest req,
                                     org.kohsuke.stapler.StaplerResponse rsp,
                                     Object o)
                              throws IOException,
                                     javax.servlet.ServletException
        Specified by:
        generateResponse in interface org.kohsuke.stapler.HttpResponse
        Throws:
        IOException
        javax.servlet.ServletException
      • ofJobNames

        public static <T extends ItemAutoCompletionCandidates ofJobNames​(Class<T> type,
                                                                           String value,
                                                                           @CheckForNull
                                                                           Item self,
                                                                           ItemGroup container)
        Auto-completes possible job names.
        Parameters:
        type - Limit the auto-completion to the subtype of this type.
        value - The value the user has typed in. Matched as a prefix.
        self - The contextual item for which the auto-completion is provided to. For example, if you are configuring a job, this is the job being configured.
        container - The nearby contextual ItemGroup to resolve relative job names from.
        Since:
        1.489
      • ofJobNames

        public static <T extends ItemAutoCompletionCandidates ofJobNames​(Class<T> type,
                                                                           String value,
                                                                           ItemGroup container)
        Auto-completes possible job names.
        Parameters:
        type - Limit the auto-completion to the subtype of this type.
        value - The value the user has typed in. Matched as a prefix.
        container - The nearby contextual ItemGroup to resolve relative job names from.
        Since:
        1.553