Class MethodInfo
- java.lang.Object
-
- org.eclipse.birt.report.model.api.metadata.MethodInfo
-
- All Implemented Interfaces:
ILocalizableInfo,IMethodInfo
public class MethodInfo extends java.lang.Object implements IMethodInfo
Represents the method information for both class and element. The class includes the argument list, return type, and whether this method is static or constructor,
-
-
Constructor Summary
Constructors Constructor Description MethodInfo(boolean isConstructor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddArgumentList(IArgumentInfoList argumentList)Adds an optional argument list to the method information.java.util.Iterator<IArgumentInfoList>argumentListIterator()Returns the iterator of argument definition.IClassInfogetClassReturnType()Returns the script type for return.java.lang.StringgetDisplayName()Returns the display name if the resource key of display name is available.java.lang.StringgetDisplayNameKey()Returns the resource key for display name.java.lang.StringgetJavaDoc()Returns the method javadoc.java.lang.StringgetName()Returns the definition name.java.lang.StringgetReturnType()Returns the script type for return.java.lang.StringgetToolTip()Returns the display string for the tool tip of this method.java.lang.StringgetToolTipKey()Returns the resource key for tool tip.booleanisConstructor()Returns whether this method is constructor.booleanisStatic()Returns whether this method is static.protected voidsetDisplayName(java.lang.String displayName)Sets the display name.protected voidsetDisplayNameKey(java.lang.String displayNameKey)Sets the resource key for display name.voidsetJavaDoc(java.lang.String javaDoc)protected voidsetName(java.lang.String name)Sets the definition name.protected voidsetReturnType(java.lang.String returnType)protected voidsetStatic(boolean isStatic)voidsetToolTip(java.lang.String toolTip)Sets the display string for the tool tip of this method.voidsetToolTipKey(java.lang.String toolTipKey)Sets the resource key for tool tip.
-
-
-
Method Detail
-
addArgumentList
protected void addArgumentList(IArgumentInfoList argumentList)
Adds an optional argument list to the method information.- Parameters:
argumentList- an optional argument list
-
argumentListIterator
public java.util.Iterator<IArgumentInfoList> argumentListIterator()
Returns the iterator of argument definition. Each one is a list that containsArgumentInfoList.- Specified by:
argumentListIteratorin interfaceIMethodInfo- Returns:
- iterator of argument definition.
-
getToolTipKey
public java.lang.String getToolTipKey()
Returns the resource key for tool tip.- Specified by:
getToolTipKeyin interfaceILocalizableInfo- Specified by:
getToolTipKeyin interfaceIMethodInfo- Returns:
- the resource key for tool tip
-
setToolTipKey
public void setToolTipKey(java.lang.String toolTipKey)
Sets the resource key for tool tip.- Parameters:
toolTipKey- the resource key to set
-
getToolTip
public java.lang.String getToolTip()
Returns the display string for the tool tip of this method.- Specified by:
getToolTipin interfaceILocalizableInfo- Specified by:
getToolTipin interfaceIMethodInfo- Returns:
- the user-visible, localized display name for the tool tip of this method.
-
setToolTip
public void setToolTip(java.lang.String toolTip)
Sets the display string for the tool tip of this method.- Parameters:
toolTip- the user-visible, localized display name for the tool tip of this method.
-
getDisplayName
public java.lang.String getDisplayName()
Description copied from interface:ILocalizableInfoReturns the display name if the resource key of display name is available. Otherwise, return empty string.- Specified by:
getDisplayNamein interfaceILocalizableInfo- Returns:
- the display name
-
setDisplayName
protected void setDisplayName(java.lang.String displayName)
Sets the display name.- Parameters:
displayName- the display value
-
getDisplayNameKey
public java.lang.String getDisplayNameKey()
Description copied from interface:ILocalizableInfoReturns the resource key for display name.- Specified by:
getDisplayNameKeyin interfaceILocalizableInfo- Returns:
- the resource key for display name
-
getName
public java.lang.String getName()
Description copied from interface:ILocalizableInfoReturns the definition name.- Specified by:
getNamein interfaceILocalizableInfo- Returns:
- the name of this definition
-
setDisplayNameKey
protected void setDisplayNameKey(java.lang.String displayNameKey)
Sets the resource key for display name.- Parameters:
displayNameKey- the resource key to set
-
setName
protected void setName(java.lang.String name)
Sets the definition name.- Parameters:
name- the name to set
-
getJavaDoc
public java.lang.String getJavaDoc()
Description copied from interface:IMethodInfoReturns the method javadoc.- Specified by:
getJavaDocin interfaceIMethodInfo- Returns:
- the javadoc
-
getReturnType
public java.lang.String getReturnType()
Description copied from interface:IMethodInfoReturns the script type for return.- Specified by:
getReturnTypein interfaceIMethodInfo- Returns:
- the script type for return
-
isConstructor
public boolean isConstructor()
Description copied from interface:IMethodInfoReturns whether this method is constructor.- Specified by:
isConstructorin interfaceIMethodInfo- Returns:
- true, if this method is constructor
-
isStatic
public boolean isStatic()
Description copied from interface:IMethodInfoReturns whether this method is static.- Specified by:
isStaticin interfaceIMethodInfo- Returns:
- true if this method is static
-
setJavaDoc
public void setJavaDoc(java.lang.String javaDoc)
- Parameters:
javaDoc-
-
setReturnType
protected void setReturnType(java.lang.String returnType)
- Parameters:
returnType-
-
setStatic
protected void setStatic(boolean isStatic)
- Parameters:
isStatic-
-
getClassReturnType
public IClassInfo getClassReturnType()
Description copied from interface:IMethodInfoReturns the script type for return.- Specified by:
getClassReturnTypein interfaceIMethodInfo- Returns:
- the script type for return
-
-