Class ExportedDescribableModel

    • Field Detail

      • model

        protected final org.jenkinsci.plugins.structs.describable.DescribableModel<?> model
      • symbol

        protected final String symbol
    • Constructor Detail

      • ExportedDescribableModel

        public ExportedDescribableModel​(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model)
      • ExportedDescribableModel

        public ExportedDescribableModel​(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model,
                                        String symbol)
    • Method Detail

      • getType

        @Exported
        public String getType()
        The Java class name for this describable (since we can't seem to export a Class<?> ...) See DescribableModel.getType()
      • getSymbol

        @Exported
        public String getSymbol()
        Provides the symbol for this describable
        Returns:
      • getDisplayName

        @Exported
        public String getDisplayName()
        Display Name of the describable class See DescribableModel.getDisplayName()
      • getHasSingleRequiredParameter

        @Exported
        public boolean getHasSingleRequiredParameter()
        Whether this describable has one and only one parameter and it is required. See DescribableModel.hasSingleRequiredParameter()
      • getHelp

        @Exported
        public String getHelp()
                       throws IOException
        Loads help defined for this object as a whole if available, else null. See DescribableModel.getHelp()
        Throws:
        IOException