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, Completion, ParameterizedCompletion

public class ShellFunctionCompletion
extends FunctionCompletion

Completion for Unix shell "functions" (command line utilities).

Version:

1.0

Author:

Robert Futrell

Nested Class Summary

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

ParameterizedCompletion.Parameter

Constructor Summary

ShellFunctionCompletion(CompletionProvider provider, String name, String returnType)
Constructor.

Method Summary

String

getSummary()

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

addDefinitionString, addParameters, getDefinitionString, getParam, getParamCount, getReturnValueDescription, getToolTipText, 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

compareTo, getAlreadyEntered, getInputText, getProvider, getRelevance, setRelevance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

compareTo, getAlreadyEntered, getInputText, getProvider, getRelevance, getReplacementText

Constructor Detail

ShellFunctionCompletion

public ShellFunctionCompletion(CompletionProvider provider,
                               String name,
                               String returnType)

Constructor.

Parameters:

provider -

name -

returnType -

Method Detail

getSummary

public String getSummary()

Specified by:

getSummary in interface Completion

Overrides:

getSummary in class FunctionCompletion