Class MethodInfo
java.lang.Object
org.eclipse.birt.report.model.api.metadata.MethodInfo
- All Implemented Interfaces:
ILocalizableInfo
,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 -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addArgumentList
(IArgumentInfoList argumentList) Adds an optional argument list to the method information.Returns the iterator of argument definition.Returns the script type for return.Returns the display name if the resource key of display name is available.Returns the resource key for display name.Returns the method javadoc.getName()
Returns the definition name.Returns the script type for return.Returns the display string for the tool tip of this method.Returns the resource key for tool tip.boolean
Returns whether this method is constructor.boolean
isStatic()
Returns whether this method is static.protected void
setDisplayName
(String displayName) Sets the display name.protected void
setDisplayNameKey
(String displayNameKey) Sets the resource key for display name.void
setJavaDoc
(String javaDoc) protected void
Sets the definition name.protected void
setReturnType
(String returnType) protected void
setStatic
(boolean isStatic) void
setToolTip
(String toolTip) Sets the display string for the tool tip of this method.void
setToolTipKey
(String toolTipKey) Sets the resource key for tool tip.
-
Constructor Details
-
MethodInfo
public MethodInfo(boolean isConstructor) - Parameters:
isConstructor
-
-
-
Method Details
-
addArgumentList
Adds an optional argument list to the method information.- Parameters:
argumentList
- an optional argument list
-
argumentListIterator
Returns the iterator of argument definition. Each one is a list that containsArgumentInfoList
.- Specified by:
argumentListIterator
in interfaceIMethodInfo
- Returns:
- iterator of argument definition.
-
getToolTipKey
Returns the resource key for tool tip.- Specified by:
getToolTipKey
in interfaceILocalizableInfo
- Specified by:
getToolTipKey
in interfaceIMethodInfo
- Returns:
- the resource key for tool tip
-
setToolTipKey
Sets the resource key for tool tip.- Parameters:
toolTipKey
- the resource key to set
-
getToolTip
Returns the display string for the tool tip of this method.- Specified by:
getToolTip
in interfaceILocalizableInfo
- Specified by:
getToolTip
in interfaceIMethodInfo
- Returns:
- the user-visible, localized display name for the tool tip of this method.
-
setToolTip
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
Description copied from interface:ILocalizableInfo
Returns the display name if the resource key of display name is available. Otherwise, return empty string.- Specified by:
getDisplayName
in interfaceILocalizableInfo
- Returns:
- the display name
-
setDisplayName
Sets the display name.- Parameters:
displayName
- the display value
-
getDisplayNameKey
Description copied from interface:ILocalizableInfo
Returns the resource key for display name.- Specified by:
getDisplayNameKey
in interfaceILocalizableInfo
- Returns:
- the resource key for display name
-
getName
Description copied from interface:ILocalizableInfo
Returns the definition name.- Specified by:
getName
in interfaceILocalizableInfo
- Returns:
- the name of this definition
-
setDisplayNameKey
Sets the resource key for display name.- Parameters:
displayNameKey
- the resource key to set
-
setName
Sets the definition name.- Parameters:
name
- the name to set
-
getJavaDoc
Description copied from interface:IMethodInfo
Returns the method javadoc.- Specified by:
getJavaDoc
in interfaceIMethodInfo
- Returns:
- the javadoc
-
getReturnType
Description copied from interface:IMethodInfo
Returns the script type for return.- Specified by:
getReturnType
in interfaceIMethodInfo
- Returns:
- the script type for return
-
isConstructor
public boolean isConstructor()Description copied from interface:IMethodInfo
Returns whether this method is constructor.- Specified by:
isConstructor
in interfaceIMethodInfo
- Returns:
- true, if this method is constructor
-
isStatic
public boolean isStatic()Description copied from interface:IMethodInfo
Returns whether this method is static.- Specified by:
isStatic
in interfaceIMethodInfo
- Returns:
- true if this method is static
-
setJavaDoc
- Parameters:
javaDoc
-
-
setReturnType
- Parameters:
returnType
-
-
setStatic
protected void setStatic(boolean isStatic) - Parameters:
isStatic
-
-
getClassReturnType
Description copied from interface:IMethodInfo
Returns the script type for return.- Specified by:
getClassReturnType
in interfaceIMethodInfo
- Returns:
- the script type for return
-