Package org.fife.rsta.ac.js.ast.jsType

Class JavaScriptFunctionType

java.lang.Object

org.fife.rsta.ac.js.ast.jsType.JavaScriptFunctionType

public class JavaScriptFunctionType
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private List<TypeDeclaration>	arguments
static Class<?>	BooleanClass
static Class<?>	ByteClass
static Class<?>	CharacterClass
static Class<?>	ClassClass
static int	CONVERSION_JS
static int	CONVERSION_NONE
static Class<?>	DateClass
static Class<?>	DoubleClass
static Class<?>	FloatClass
static Class<?>	IntegerClass
static Class<?>	JSArray
static Class<?>	JSBooleanClass
static Class<?>	JSDateClass
static Class<?>	JSNumberClass
static Class<?>	JSObjectClass
static Class<?>	JSStringClass
private static final int	JSTYPE_ARRAY
private static final int	JSTYPE_BOOLEAN
private static final int	JSTYPE_NUMBER
private static final int	JSTYPE_OBJECT
private static final int	JSTYPE_STRING
private static final int	JSTYPE_UNDEFINED
static Class<?>	LongClass
private String	name
static Class<?>	NumberClass
static Class<?>	ObjectClass
static Class<?>	ShortClass
static Class<?>	StringClass

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavaScriptFunctionType(String name, List<TypeDeclaration> arguments, SourceCompletionProvider provider)
private	JavaScriptFunctionType(String name, SourceCompletionProvider provider)

Method Summary

Modifier and Type	Method	Description
void	addArgument(TypeDeclaration type)
int	compare(JavaScriptFunctionType compareType, SourceCompletionProvider provider, boolean isJavaScriptType)	Compare this JavaScriptFunctionType with another and return a weight integer based on the parameters matching or whether the parameters are compatible.
private int	compareParameters(TypeDeclaration param, TypeDeclaration compareParam, SourceCompletionProvider provider)	Converts TypeDeclaration into Java Class and compares whether another parameter is compatible based on JSR-223
private Class<?>	convertClassToJavaClass(String name, TypeDeclarationFactory typesFactory)	Converts TypeDeclaration qualified name to Java Class
private TypeDeclaration	convertParamType(TypeDeclaration type, SourceCompletionProvider provider)	Convert parameter into TypeDeclaration
TypeDeclaration	getArgument(int index)
int	getArgumentCount()
List<TypeDeclaration>	getArguments()
private static int	getJSTypeCode(String clsName, TypeDeclarationFactory typesFactory)	Converts JavaScript class name to integer code
String	getName()
(package private) static int	getSizeRank(Class<?> aType)
static JavaScriptFunctionType	parseFunction(String function, SourceCompletionProvider provider)	Convenience method to parse function string and converts to JavaScriptFunctionType

Methods inherited from class java.lang.Object

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

Field Details

CONVERSION_NONE

public static int CONVERSION_NONE

CONVERSION_JS

public static int CONVERSION_JS

BooleanClass

public static Class<?> BooleanClass

ByteClass

public static Class<?> ByteClass

CharacterClass

public static Class<?> CharacterClass

ClassClass

public static Class<?> ClassClass

DoubleClass

public static Class<?> DoubleClass

FloatClass

public static Class<?> FloatClass

IntegerClass

public static Class<?> IntegerClass

LongClass

public static Class<?> LongClass

NumberClass

public static Class<?> NumberClass

ObjectClass

public static Class<?> ObjectClass

ShortClass

public static Class<?> ShortClass

StringClass

public static Class<?> StringClass

DateClass

public static Class<?> DateClass

JSBooleanClass

public static Class<?> JSBooleanClass

JSStringClass

public static Class<?> JSStringClass

JSNumberClass

public static Class<?> JSNumberClass

JSObjectClass

public static Class<?> JSObjectClass

JSDateClass

public static Class<?> JSDateClass

JSArray

public static Class<?> JSArray

name

private String name

arguments

private List<TypeDeclaration> arguments

JSTYPE_UNDEFINED

private static final int JSTYPE_UNDEFINED

See Also:

• Constant Field Values

JSTYPE_BOOLEAN

private static final int JSTYPE_BOOLEAN

See Also:

• Constant Field Values

JSTYPE_NUMBER

private static final int JSTYPE_NUMBER

See Also:

• Constant Field Values

JSTYPE_STRING

private static final int JSTYPE_STRING

See Also:

• Constant Field Values

JSTYPE_ARRAY

private static final int JSTYPE_ARRAY

See Also:

• Constant Field Values

JSTYPE_OBJECT

private static final int JSTYPE_OBJECT

See Also:

• Constant Field Values

Constructor Details

JavaScriptFunctionType

private JavaScriptFunctionType(String name,
 SourceCompletionProvider provider)

JavaScriptFunctionType

private JavaScriptFunctionType(String name,
 List<TypeDeclaration> arguments,
 SourceCompletionProvider provider)

Method Details

getName

public String getName()

getArguments

public List<TypeDeclaration> getArguments()

addArgument

public void addArgument(TypeDeclaration type)

getArgumentCount

public int getArgumentCount()

getArgument

public TypeDeclaration getArgument(int index)

compare

public int compare(JavaScriptFunctionType compareType,
 SourceCompletionProvider provider,
 boolean isJavaScriptType)

Compare this JavaScriptFunctionType with another and return a weight integer based on the parameters matching or whether the parameters are compatible.

Parameters:

compareType - method to compare with this

provider - SourceCompletionProvider

Returns:

weight based on the compatibleness of method to compare

convertParamType

private TypeDeclaration convertParamType(TypeDeclaration type,
 SourceCompletionProvider provider)

Convert parameter into TypeDeclaration

Parameters:

type -

provider -

Returns:

compareParameters

private int compareParameters(TypeDeclaration param,
 TypeDeclaration compareParam,
 SourceCompletionProvider provider)

Converts TypeDeclaration into Java Class and compares whether another parameter is compatible based on JSR-223

Parameters:

param - parameter to compare

compareParam - compare parameter

provider - SourceCompletionProvider

Returns:

convertClassToJavaClass

private Class<?> convertClassToJavaClass(String name,
 TypeDeclarationFactory typesFactory)
                                  throws ClassNotFoundException

Converts TypeDeclaration qualified name to Java Class

Parameters:

name -

Returns:

Throws:

ClassNotFoundException

parseFunction

public static JavaScriptFunctionType parseFunction(String function,
 SourceCompletionProvider provider)

Convenience method to parse function string and converts to JavaScriptFunctionType

Parameters:

function - String to parse e.g. convertValue(java.util.String val);

provider - used for type conversions

Returns:

getJSTypeCode

private static int getJSTypeCode(String clsName,
 TypeDeclarationFactory typesFactory)
                          throws ClassNotFoundException

Converts JavaScript class name to integer code

Parameters:

clsName -

Returns:

Throws:

ClassNotFoundException

getSizeRank

static int getSizeRank(Class<?> aType)