Class MethodInfo

java.lang.Object
org.eclipse.birt.report.model.api.metadata.MethodInfo
All Implemented Interfaces:
ILocalizableInfo, IMethodInfo

public class MethodInfo extends 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 Details

    • MethodInfo

      public MethodInfo(boolean isConstructor)
      Parameters:
      isConstructor -
  • Method Details

    • addArgumentList

      protected void addArgumentList(IArgumentInfoList argumentList)
      Adds an optional argument list to the method information.
      Parameters:
      argumentList - an optional argument list
    • argumentListIterator

      public Iterator<IArgumentInfoList> argumentListIterator()
      Returns the iterator of argument definition. Each one is a list that contains ArgumentInfoList.
      Specified by:
      argumentListIterator in interface IMethodInfo
      Returns:
      iterator of argument definition.
    • getToolTipKey

      public String getToolTipKey()
      Returns the resource key for tool tip.
      Specified by:
      getToolTipKey in interface ILocalizableInfo
      Specified by:
      getToolTipKey in interface IMethodInfo
      Returns:
      the resource key for tool tip
    • setToolTipKey

      public void setToolTipKey(String toolTipKey)
      Sets the resource key for tool tip.
      Parameters:
      toolTipKey - the resource key to set
    • getToolTip

      public String getToolTip()
      Returns the display string for the tool tip of this method.
      Specified by:
      getToolTip in interface ILocalizableInfo
      Specified by:
      getToolTip in interface IMethodInfo
      Returns:
      the user-visible, localized display name for the tool tip of this method.
    • setToolTip

      public void setToolTip(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 String 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 interface ILocalizableInfo
      Returns:
      the display name
    • setDisplayName

      protected void setDisplayName(String displayName)
      Sets the display name.
      Parameters:
      displayName - the display value
    • getDisplayNameKey

      public String getDisplayNameKey()
      Description copied from interface: ILocalizableInfo
      Returns the resource key for display name.
      Specified by:
      getDisplayNameKey in interface ILocalizableInfo
      Returns:
      the resource key for display name
    • getName

      public String getName()
      Description copied from interface: ILocalizableInfo
      Returns the definition name.
      Specified by:
      getName in interface ILocalizableInfo
      Returns:
      the name of this definition
    • setDisplayNameKey

      protected void setDisplayNameKey(String displayNameKey)
      Sets the resource key for display name.
      Parameters:
      displayNameKey - the resource key to set
    • setName

      protected void setName(String name)
      Sets the definition name.
      Parameters:
      name - the name to set
    • getJavaDoc

      public String getJavaDoc()
      Description copied from interface: IMethodInfo
      Returns the method javadoc.
      Specified by:
      getJavaDoc in interface IMethodInfo
      Returns:
      the javadoc
    • getReturnType

      public String getReturnType()
      Description copied from interface: IMethodInfo
      Returns the script type for return.
      Specified by:
      getReturnType in interface IMethodInfo
      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 interface IMethodInfo
      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 interface IMethodInfo
      Returns:
      true if this method is static
    • setJavaDoc

      public void setJavaDoc(String javaDoc)
      Parameters:
      javaDoc -
    • setReturnType

      protected void setReturnType(String returnType)
      Parameters:
      returnType -
    • setStatic

      protected void setStatic(boolean isStatic)
      Parameters:
      isStatic -
    • getClassReturnType

      public IClassInfo getClassReturnType()
      Description copied from interface: IMethodInfo
      Returns the script type for return.
      Specified by:
      getClassReturnType in interface IMethodInfo
      Returns:
      the script type for return