Class PackageHint

    • Constructor Detail

      • PackageHint

        public PackageHint​(java.lang.String pathElement,
                           java.lang.String currentPath)
    • Method Detail

      • getAutocompleteText

        public java.lang.String getAutocompleteText()
        Specified by:
        getAutocompleteText in interface ScriptFunctionHint
        Returns:
        The String to insert if the user chooses to auto-complete this hint.
      • getMethodSignature

        public java.lang.String getMethodSignature()
        Specified by:
        getMethodSignature in interface ScriptFunctionHint
        Returns:
        The formatted String to use as the method signature.
      • getMethodDescription

        public java.lang.String getMethodDescription()
        Specified by:
        getMethodDescription in interface ScriptFunctionHint
        Returns:
        A description of what the function does.
      • getParameterDescriptions

        public java.util.Map<java.lang.String,​java.lang.String> getParameterDescriptions()
        Specified by:
        getParameterDescriptions in interface ScriptFunctionHint
        Returns:
        Map of parameter names matched to their descriptions.