Package org.fife.rsta.ac.sh

Class ShellFunctionCompletion

  • All Implemented Interfaces:
    java.lang.Comparable<org.fife.ui.autocomplete.Completion>, org.fife.ui.autocomplete.Completion, org.fife.ui.autocomplete.ParameterizedCompletion
    public class ShellFunctionCompletion
extends org.fife.ui.autocomplete.FunctionCompletion
    Completion for Unix shell "functions" (command line utilities).
    Version:
    1.0

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.fife.ui.autocomplete.ParameterizedCompletion

        org.fife.ui.autocomplete.ParameterizedCompletion.Parameter

    • Constructor Summary

      Constructors 
      Constructor Description
      ShellFunctionCompletion​(org.fife.ui.autocomplete.CompletionProvider provider, java.lang.String name, java.lang.String returnType)
      Constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getSummary()  
      private java.lang.String getSummaryFromManPage()
      Gets a summary of this function from the local system's man pages.
      private static java.lang.StringBuffer manToHtml​(java.lang.CharSequence text)  
      private static java.lang.String quoteReplacement​(java.lang.String text)  

      • Methods inherited from class org.fife.ui.autocomplete.FunctionCompletion

        addDefinitionString, addParameters, compareTo, equals, getDefinitionString, getInsertionInfo, getParam, getParamCount, getReturnValueDescription, getShowParameterToolTip, getToolTipText, hashCode, setParams, setReturnValueDescription

      • Methods inherited from class org.fife.ui.autocomplete.VariableCompletion

        getDefinedIn, getName, getType, possiblyAddDefinedIn, possiblyAddDescription, setDefinedIn, toString

      • Methods inherited from class org.fife.ui.autocomplete.BasicCompletion

        getReplacementText, getShortDescription, setShortDescription, setSummary

      • Methods inherited from class org.fife.ui.autocomplete.AbstractCompletion

        getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, setIcon, setRelevance

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.fife.ui.autocomplete.Completion

        getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, getReplacementText

    • Constructor Detail

      • ShellFunctionCompletion

        public ShellFunctionCompletion​(org.fife.ui.autocomplete.CompletionProvider provider,
                               java.lang.String name,
                               java.lang.String returnType)
        Constructor.
        Parameters:
        provider - The completion provider.
        name - The name of the function.
        returnType - The return type of the function.

    • Method Detail

      • getSummary

        public java.lang.String getSummary()
        Specified by:
        getSummary in interface org.fife.ui.autocomplete.Completion
        Overrides:
        getSummary in class org.fife.ui.autocomplete.FunctionCompletion

      • getSummaryFromManPage

        private java.lang.String getSummaryFromManPage()
        Gets a summary of this function from the local system's man pages.
        Returns:
        The summary.

      • manToHtml

        private static java.lang.StringBuffer manToHtml​(java.lang.CharSequence text)

      • quoteReplacement

        private static java.lang.String quoteReplacement​(java.lang.String text)