Package jp.ikedam.jenkins.plugins.extensible_choice_parameter

Class GlobalTextareaChoiceListProvider.DescriptorImpl

  • All Implemented Interfaces:
    Saveable, OnMaster
    Enclosing class:
    GlobalTextareaChoiceListProvider
    @Extension
public static class GlobalTextareaChoiceListProvider.DescriptorImpl
extends ChoiceListProviderDescriptor
    The internal class to work with views. Also manage the global configuration. The following files are used (put in main/resource directory in the source tree).
    config.jelly
    Shown as a part of a job configuration page when this provider is selected. Provides additional configuration fields of a Extensible Choice.
    global.jelly
    Shown as a part of the System Configuration page. Call config.jelly of GlobalTextareaChoiceListEntry, for each set of choices.

    • Constructor Detail

      • DescriptorImpl

        public DescriptorImpl()
        Restore from the global configuration

    • Method Detail

      • getChoiceListEntryList

        public List<GlobalTextareaChoiceListEntry> getChoiceListEntryList()
        The list of available sets of choices.
        Returns:
        the list of GlobalTextareaChoiceListEntry

      • setChoiceListEntryList

        public void setChoiceListEntryList​(List<GlobalTextareaChoiceListEntry> choiceListEntryList)
        Set a list of available sets of choices.
        Parameters:
        choiceListEntryList - a list of GlobalTextareaChoiceListEntry

      • doFillNameItems

        public ListBoxModel doFillNameItems()
        Returns a list of the names of the available choice set. Used in dropdown field of a job configuration page.
        Returns:
        a list of the names of the available choice set

      • doFillDefaultChoiceItems

        public ListBoxModel doFillDefaultChoiceItems​(@QueryParameter
                                             String name)

      • getNoDefaultChoice

        public String getNoDefaultChoice()
        Returns:
        the special value used for "No default choice" (use the top most)

      • getChoiceListEntry

        public GlobalTextareaChoiceListEntry getChoiceListEntry​(String name)
        Retrieve the set of choices entry by the name. If multiple candidates exists, returns the first one.
        Parameters:
        name -
        Returns:
        the set of choices.

      • getChoiceList

        public List<String> getChoiceList​(String name)
        Retrieve the set of choices entry by the name. if no entry matches, return empty list.
        Parameters:
        name -
        Returns:
        the list of choices. never null.