Class AbstractParameterDescriptionProvider

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String describe​(java.lang.String paramName)
      Returns description of the parameter or null if this extension does not know anything about this parameter.
      boolean isVisible​(java.lang.String paramName)
      Called to check if parameter should be shown in the UI
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AbstractParameterDescriptionProvider

        public AbstractParameterDescriptionProvider()
    • Method Detail

      • describe

        public java.lang.String describe​(@NotNull
                                         java.lang.String paramName)
        Description copied from interface: ParameterDescriptionProvider
        Returns description of the parameter or null if this extension does not know anything about this parameter.
        Specified by:
        describe in interface ParameterDescriptionProvider
        Parameters:
        paramName - name of the parameter (may have system. or env. prefix)
        Returns:
        description or null
      • isVisible

        public boolean isVisible​(@NotNull
                                 java.lang.String paramName)
        Description copied from interface: ParameterDescriptionProvider
        Called to check if parameter should be shown in the UI
        Specified by:
        isVisible in interface ParameterDescriptionProvider
        Parameters:
        paramName - name of parameter
        Returns:
        true to let parameter be shown in the UI, false to hide parameter