Package gw.internal.gosu.parser

Class JavaMethodInfo

java.lang.Object

gw.lang.reflect.BaseFeatureInfo

gw.internal.gosu.parser.JavaBaseFeatureInfo

gw.internal.gosu.parser.JavaMethodInfo

All Implemented Interfaces:

JavaHasParams, ICanHaveAnnotationDefault, IAnnotatedFeatureInfo, IAttributedFeatureInfo, IFeatureInfo, IGenericMethodInfo, IHasParameterInfos, IMethodInfo, IOptionalParamCapable, IJavaMethodInfo

public class JavaMethodInfo
extends JavaBaseFeatureInfo
implements IJavaMethodInfo

Nested Class Summary

Nested classes/interfaces inherited from interface gw.lang.reflect.IAnnotatedFeatureInfo

IAnnotatedFeatureInfo.IAnnotationInfoHelper

Nested classes/interfaces inherited from interface gw.lang.reflect.IAttributedFeatureInfo

IAttributedFeatureInfo.MODIFIER

Field Summary

Fields

Modifier and Type	Field	Description
private IMethodCallHandler	_callHandler
private List<IExceptionInfo>	_exceptions
private boolean	_forceHidden
private IJavaMethodDescriptor	_md
private IDocRef<IMethodNode>	_methodDocs
private String	_name
private IParameterInfo[]	_params
private IType	_retType
private String	_signature
private int	_staticCache
private IGenericTypeVariable[]	_typeVars
private static final int	FALSE_ENC
private static final int	TRUE_ENC
private static final int	UNINITED

Fields inherited from interface gw.lang.reflect.IAnnotatedFeatureInfo

ANNOTATION_HELPER

Constructor Summary

Constructors

Constructor	Description
JavaMethodInfo(IFeatureInfo container, IJavaMethodDescriptor md, boolean forceHidden)

Method Summary

Modifier and Type	Method	Description
static TypeVarToTypeMap	addEnclosingTypeParams(IType declaringClass, TypeVarToTypeMap actualParamByVarName)
(package private) static IParameterInfo[]	convertGenericParameterTypes(IFeatureInfo container, TypeVarToTypeMap actualParamByVarName, IJavaClassType[] paramTypes, IJavaClassInfo declaringClass, List<Parameter> paramInfos)
private IParameterInfo[]	convertParameterDescriptors()
private IType[]	convertTypes(IJavaClassType[] genParamTypes, IType ownersType)
protected IJavaAnnotatedElement	getAnnotatedElement()
Object	getAnnotationDefault()
IMethodCallHandler	getCallHandler()
List<IAnnotationInfo>	getDeclaredAnnotations()
IExpression[]	getDefaultValueExpressions()
String	getDeprecatedReason()
String	getDescription()	A full description of this feature.
String	getDisplayName()	Gets the display name of this feature.
IDocRef<IParamNode>	getDocsForParam(int paramIndex)
List<IExceptionInfo>	getExceptions()
ILocationInfo	getLocationInfo()
IJavaClassMethod	getMethod()
IDocRef<IMethodNode>	getMethodDocs()
int	getModifiers()
String	getName()	Gets the programmatic name or identifier of this feature.
IType[]	getParameterizedParameterTypes(IType... typeParams)
IType[]	getParameterizedParameterTypes2(IType ownersType, IType... typeParams)
IType	getParameterizedReturnType(IType... typeParams)
String[]	getParameterNames()
IParameterInfo[]	getParameters()
Method	getRawMethod()
String	getReturnDescription()
IType	getReturnType()
String	getShortDescription()
IGenericTypeVariable[]	getTypeVariables()
boolean	hasAnnotationDefault()
TypeVarToTypeMap	inferTypeParametersFromArgumentTypes(IType... argTypes)
TypeVarToTypeMap	inferTypeParametersFromArgumentTypes2(IType owningParameterizedType, IType... argTypes)
private TypeVarToTypeMap	initTypeVarMap()
boolean	isAbstract()
protected boolean	isDefaultEnumFeature()
boolean	isDefaultImpl()
boolean	isDeprecated()
boolean	isFinal()
boolean	isHidden()	True if this feature is hidden.
protected boolean	isHiddenViaFeatureDescriptor()
boolean	isInternal()	True if this feature is internal.
private boolean	isJavadocDeprecated()
boolean	isPrivate()	True if this feature is private.
boolean	isProtected()	True if this feature is protected.
boolean	isPublic()	True if this feature is public.
boolean	isStatic()	True if this feature is static, meaning the feature is not specific to a particular instance of the feature's containing type.
private boolean	isVarArgs()
boolean	isVisible(IScriptabilityModifier constraint)	Determine if this feature is visible given a visibility constraint.
protected boolean	isVisibleViaFeatureDescriptor(IScriptabilityModifier constraint)
private String	makeSignature()
String	toString()

Methods inherited from class gw.internal.gosu.parser.JavaBaseFeatureInfo

makeDeprecated

Methods inherited from class gw.lang.reflect.BaseFeatureInfo

getAnnotation, getAnnotations, getAnnotationsOfType, getContainer, getOwnersType, getParamTypes, getSuperAnnotatedElements, hasAnnotation, hasDeclaredAnnotation, isInternalAPI, isReified, isScriptable

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.lang.reflect.IAnnotatedFeatureInfo

getAnnotation, getAnnotations, getAnnotationsOfType, hasAnnotation, hasDeclaredAnnotation

Methods inherited from interface gw.lang.reflect.IAttributedFeatureInfo

isReified, isScriptable

Methods inherited from interface gw.lang.reflect.IFeatureInfo

getContainer, getOwnersType

Field Details

UNINITED

private static final int UNINITED

See Also:

• Constant Field Values

TRUE_ENC

private static final int TRUE_ENC

See Also:

• Constant Field Values

FALSE_ENC

private static final int FALSE_ENC

See Also:

• Constant Field Values

_md

private IJavaMethodDescriptor _md

_forceHidden

private boolean _forceHidden

_params

private IParameterInfo[] _params

_retType

private IType _retType

_callHandler

private IMethodCallHandler _callHandler

_typeVars

private IGenericTypeVariable[] _typeVars

_staticCache

private int _staticCache

_exceptions

private List<IExceptionInfo> _exceptions

_methodDocs

private IDocRef<IMethodNode> _methodDocs

_name

private String _name

_signature

private String _signature

Constructor Details

JavaMethodInfo

public JavaMethodInfo(IFeatureInfo container,
 IJavaMethodDescriptor md,
 boolean forceHidden)

Parameters:

container - Typically this will be the containing ITypeInfo

md - The method descriptor (from BeanInfo)

Method Details

getParameters

public IParameterInfo[] getParameters()

Specified by:

getParameters in interface IHasParameterInfos

Specified by:

getParameters in interface IMethodInfo

getReturnType

public IType getReturnType()

Specified by:

getReturnType in interface IMethodInfo

addEnclosingTypeParams

public static TypeVarToTypeMap addEnclosingTypeParams(IType declaringClass,
 TypeVarToTypeMap actualParamByVarName)

getDeclaredAnnotations

public List<IAnnotationInfo> getDeclaredAnnotations()

Specified by:

getDeclaredAnnotations in interface IAnnotatedFeatureInfo

Overrides:

getDeclaredAnnotations in class JavaBaseFeatureInfo

Returns:

A map of AnnotationInfo objects by type representing all the annotations associated with this feature, or an empty map if there are no annotations.

getTypeVariables

public IGenericTypeVariable[] getTypeVariables()

Specified by:

getTypeVariables in interface IGenericMethodInfo

Returns:

An array of generic type variables if this feature corresponds with a generic type.

getParameterizedReturnType

public IType getParameterizedReturnType(IType... typeParams)

Specified by:

getParameterizedReturnType in interface IGenericMethodInfo

getParameterizedParameterTypes

public IType[] getParameterizedParameterTypes(IType... typeParams)

Specified by:

getParameterizedParameterTypes in interface IGenericMethodInfo

getParameterizedParameterTypes2

public IType[] getParameterizedParameterTypes2(IType ownersType,
 IType... typeParams)

Specified by:

getParameterizedParameterTypes2 in interface IGenericMethodInfo

inferTypeParametersFromArgumentTypes

public TypeVarToTypeMap inferTypeParametersFromArgumentTypes(IType... argTypes)

Specified by:

inferTypeParametersFromArgumentTypes in interface IGenericMethodInfo

Parameters:

argTypes - The argument types from a generic method call.

Returns:

A map of inferred type parameters based on the argTypes. The map contains only the types that could be inferred -- the map may be empty.

E.g., given generic method: T[] toArray( T[] ) and call: list.toArray( new String[list.size()] ); => the toArray() method call should be automatically parameterized with based on the new String[0].

inferTypeParametersFromArgumentTypes2

public TypeVarToTypeMap inferTypeParametersFromArgumentTypes2(IType owningParameterizedType,
 IType... argTypes)

Specified by:

inferTypeParametersFromArgumentTypes2 in interface IGenericMethodInfo

convertTypes

private IType[] convertTypes(IJavaClassType[] genParamTypes,
 IType ownersType)

getCallHandler

public IMethodCallHandler getCallHandler()

Specified by:

getCallHandler in interface IMethodInfo

getReturnDescription

public String getReturnDescription()

Specified by:

getReturnDescription in interface IMethodInfo

getExceptions

public List<IExceptionInfo> getExceptions()

Specified by:

getExceptions in interface IMethodInfo

getName

public String getName()

Description copied from interface: IFeatureInfo

Gets the programmatic name or identifier of this feature. Note this name should follow Java identifier naming conventions (alpha-num and underscores, but can't start with a digit).

Specified by:

getName in interface IFeatureInfo

Specified by:

getName in interface IMethodInfo

makeSignature

private String makeSignature()

getDisplayName

public String getDisplayName()

Description copied from interface: IFeatureInfo

Gets the display name of this feature. There is no guarantee this display name is localized.

Specified by:

getDisplayName in interface IFeatureInfo

Overrides:

getDisplayName in class BaseFeatureInfo

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface IJavaMethodInfo

getDescription

public String getDescription()

Description copied from interface: IFeatureInfo

A full description of this feature.

Specified by:

getDescription in interface IFeatureInfo

Overrides:

getDescription in class BaseFeatureInfo

isHidden

public boolean isHidden()

Description copied from interface: IAttributedFeatureInfo

True if this feature is hidden. Hidden feature should not to be exposed to earthlings.

Specified by:

isHidden in interface IAttributedFeatureInfo

Overrides:

isHidden in class JavaBaseFeatureInfo

isDefaultEnumFeature

protected boolean isDefaultEnumFeature()

Specified by:

isDefaultEnumFeature in class JavaBaseFeatureInfo

isVisible

public boolean isVisible(IScriptabilityModifier constraint)

Description copied from interface: IAttributedFeatureInfo

Determine if this feature is visible given a visibility constraint.

NOTE: implementers of this method are responsible for handling the null case, taken to mean that there are not scriptability constraints.

Specified by:

isVisible in interface IAttributedFeatureInfo

Overrides:

isVisible in class JavaBaseFeatureInfo

isStatic

public boolean isStatic()

Description copied from interface: IAttributedFeatureInfo

True if this feature is static, meaning the feature is not specific to a particular instance of the feature's containing type.

Specified by:

isStatic in interface IAttributedFeatureInfo

isPrivate

public boolean isPrivate()

Description copied from interface: IAttributedFeatureInfo

True if this feature is private. Private features are only accessible from within the type that owns them.

Specified by:

isPrivate in interface IAttributedFeatureInfo

Overrides:

isPrivate in class BaseFeatureInfo

isInternal

public boolean isInternal()

Description copied from interface: IAttributedFeatureInfo

True if this feature is internal. Internal features are accessible from within the type that owns them and from other types in the same namespace.

Specified by:

isInternal in interface IAttributedFeatureInfo

Overrides:

isInternal in class BaseFeatureInfo

isProtected

public boolean isProtected()

Description copied from interface: IAttributedFeatureInfo

True if this feature is protected. Protected features are accessible from within the type that owns them and from derived containers.

Specified by:

isProtected in interface IAttributedFeatureInfo

Overrides:

isProtected in class BaseFeatureInfo

isPublic

public boolean isPublic()

Description copied from interface: IAttributedFeatureInfo

True if this feature is public. Public features are not restricted.

Specified by:

isPublic in interface IAttributedFeatureInfo

Overrides:

isPublic in class BaseFeatureInfo

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface IAttributedFeatureInfo

Overrides:

isAbstract in class BaseFeatureInfo

isFinal

public boolean isFinal()

Specified by:

isFinal in interface IAttributedFeatureInfo

Overrides:

isFinal in class BaseFeatureInfo

isDefaultImpl

public boolean isDefaultImpl()

Specified by:

isDefaultImpl in interface IAnnotatedFeatureInfo

Overrides:

isDefaultImpl in class BaseFeatureInfo

Returns:

True if this feature is the default implementation e.g., default interface method

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface IAnnotatedFeatureInfo

Overrides:

isDeprecated in class BaseFeatureInfo

Returns:

True if this feature is deprecated.

isJavadocDeprecated

private boolean isJavadocDeprecated()

getDeprecatedReason

public String getDeprecatedReason()

Specified by:

getDeprecatedReason in interface IAnnotatedFeatureInfo

Overrides:

getDeprecatedReason in class BaseFeatureInfo

Returns:

The deprecation message, or null if the feature is not deprecated.

hasAnnotationDefault

public boolean hasAnnotationDefault()

Specified by:

hasAnnotationDefault in interface ICanHaveAnnotationDefault

getAnnotationDefault

public Object getAnnotationDefault()

Specified by:

getAnnotationDefault in interface ICanHaveAnnotationDefault

convertParameterDescriptors

private IParameterInfo[] convertParameterDescriptors()

initTypeVarMap

private TypeVarToTypeMap initTypeVarMap()

convertGenericParameterTypes

static IParameterInfo[] convertGenericParameterTypes(IFeatureInfo container,
 TypeVarToTypeMap actualParamByVarName,
 IJavaClassType[] paramTypes,
 IJavaClassInfo declaringClass,
 List<Parameter> paramInfos)

isVarArgs

private boolean isVarArgs()

getDefaultValueExpressions

public IExpression[] getDefaultValueExpressions()

Specified by:

getDefaultValueExpressions in interface IOptionalParamCapable

Returns:

An array of objects representing the default values for a function's parameters. Returns an empty array if there are no default values, otherwise returns an array corresponding with default parameter values. If a parameter does not have a default value, it's default value is null in the array.

getParameterNames

public String[] getParameterNames()

Specified by:

getParameterNames in interface IOptionalParamCapable

getMethod

public IJavaClassMethod getMethod()

Specified by:

getMethod in interface IJavaMethodInfo

toString

public String toString()

Overrides:

toString in class BaseFeatureInfo

getAnnotatedElement

protected IJavaAnnotatedElement getAnnotatedElement()

Specified by:

getAnnotatedElement in class JavaBaseFeatureInfo

isVisibleViaFeatureDescriptor

protected boolean isVisibleViaFeatureDescriptor(IScriptabilityModifier constraint)

Specified by:

isVisibleViaFeatureDescriptor in class JavaBaseFeatureInfo

isHiddenViaFeatureDescriptor

protected boolean isHiddenViaFeatureDescriptor()

Specified by:

isHiddenViaFeatureDescriptor in class JavaBaseFeatureInfo

getDocsForParam

public IDocRef<IParamNode> getDocsForParam(int paramIndex)

Specified by:

getDocsForParam in interface JavaHasParams

getMethodDocs

public IDocRef<IMethodNode> getMethodDocs()

Specified by:

getMethodDocs in interface IJavaMethodInfo

getRawMethod

public Method getRawMethod()

Specified by:

getRawMethod in interface IJavaMethodInfo

getModifiers

public int getModifiers()

Specified by:

getModifiers in interface IJavaMethodInfo

getLocationInfo

public ILocationInfo getLocationInfo()

Specified by:

getLocationInfo in interface IFeatureInfo