Package org.fife.rsta.ac.js.completion

Class JSMethodData

java.lang.Object

org.fife.rsta.ac.js.completion.JSMethodData

public class JSMethodData
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
private MethodInfo	info
private JarManager	jarManager
private java.util.ArrayList<java.lang.String>	paramNames

Constructor Summary

Constructors

Constructor	Description
JSMethodData(MethodInfo info, JarManager jarManager)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getEnclosingClassName(boolean fullyQualified)
Method	getMethod()
private Method	getMethodFromSourceLoc(SourceLocation loc, ClassFile cf)	Scours the source in a location (zip file, directory), looking for a particular class's source.
MethodInfo	getMethodInfo()
int	getParameterCount()
java.lang.String	getParameterName(int index)	Returns the name of the specified parameter to this method, or null if it cannot be determined.
java.lang.String	getParameterType(java.lang.String[] paramTypes, int index, org.fife.ui.autocomplete.CompletionProvider provider)
java.lang.String	getSummary()
private java.lang.String	getSummaryFromSourceLoc(SourceLocation loc, ClassFile cf)	Scours the source in a location (zip file, directory), looking for a particular class's source.
java.lang.String	getType(boolean qualified)
boolean	isStatic()

Methods inherited from class java.lang.Object

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

Field Detail

info

private MethodInfo info

jarManager

private JarManager jarManager

paramNames

private java.util.ArrayList<java.lang.String> paramNames

Constructor Detail

JSMethodData

public JSMethodData(MethodInfo info,
                    JarManager jarManager)

Method Detail

getParameterName

public java.lang.String getParameterName(int index)

Returns the name of the specified parameter to this method, or null if it cannot be determined.

Parameters:

index - The index of the parameter.

Returns:

The name of the parameter, or null.

getParameterType

public java.lang.String getParameterType(java.lang.String[] paramTypes,
                                         int index,
                                         org.fife.ui.autocomplete.CompletionProvider provider)

getSummary

public java.lang.String getSummary()

getMethod

public Method getMethod()

getSummaryFromSourceLoc

private java.lang.String getSummaryFromSourceLoc(SourceLocation loc,
                                                 ClassFile cf)

Scours the source in a location (zip file, directory), looking for a particular class's source. If it is found, it is parsed, and the Javadoc for this method (if any) is returned.

Parameters:

loc - The zip file, jar file, or directory to look in.

cf - The ClassFile representing the class of this method.

Returns:

The summary, or null if the method has no javadoc, the class's source was not found, or an IO error occurred.

getMethodFromSourceLoc

private Method getMethodFromSourceLoc(SourceLocation loc,
                                      ClassFile cf)

Scours the source in a location (zip file, directory), looking for a particular class's source. If it is found, it is parsed, and the Method for this method (if any) is returned.

Parameters:

loc - The zip file, jar file, or directory to look in.

cf - The ClassFile representing the class of this method.

Returns:

The method, or null if it cannot be found, or an IO error occurred.

getMethodInfo

public MethodInfo getMethodInfo()

getType

public java.lang.String getType(boolean qualified)

getParameterCount

public int getParameterCount()

isStatic

public boolean isStatic()

getEnclosingClassName

public java.lang.String getEnclosingClassName(boolean fullyQualified)