Package org.fife.rsta.ac.sh

Class ShellFunctionCompletion

java.lang.Object

org.fife.ui.autocomplete.AbstractCompletion

org.fife.ui.autocomplete.BasicCompletion

org.fife.ui.autocomplete.VariableCompletion

org.fife.ui.autocomplete.FunctionCompletion

org.fife.rsta.ac.sh.ShellFunctionCompletion

All Implemented Interfaces:

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, String name, String returnType)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getSummary()
private String	getSummaryFromManPage()	Gets a summary of this function from the local system's man pages.
private static StringBuffer	manToHtml(CharSequence text)
private static String	quoteReplacement(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 Details

ShellFunctionCompletion

public ShellFunctionCompletion(org.fife.ui.autocomplete.CompletionProvider provider,
 String name,
 String returnType)

Constructor.

Parameters:

provider - The completion provider.

name - The name of the function.

returnType - The return type of the function.

Method Details

getSummary

public String getSummary()

Specified by:

getSummary in interface org.fife.ui.autocomplete.Completion

Overrides:

getSummary in class org.fife.ui.autocomplete.FunctionCompletion

getSummaryFromManPage

private String getSummaryFromManPage()

Gets a summary of this function from the local system's man pages.

Returns:

The summary.

manToHtml

private static StringBuffer manToHtml(CharSequence text)

quoteReplacement

private static String quoteReplacement(String text)