Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api.scripts
Class MethodInfo

    java.lang.Object
      org.eclipse.birt.report.model.api.scripts.MethodInfo

All Implemented Interfaces:
  ILocalizableInfo, IMethodInfo

Direct Known Subclasses:
  TemplateMethodInfo

    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
`protected` | `MethodInfo(java.lang.reflect.Method method)`

Method Summary
`java.util.Iterator` | `argumentListIterator()` Returns the iterator of argument definition.
`IClassInfo` | `getClassReturnType()` Returns the script type for return.
`java.lang.String` | `getDisplayName()` Returns the display name if the resource key of display name is available.
`java.lang.String` | `getDisplayNameKey()` Returns the resource key for display name.
`java.lang.String` | `getJavaDoc()` Returns the method javadoc.
`protected java.lang.reflect.Method` | `getMethod()` Returns the internal Java Method instance.
`java.lang.String` | `getName()` Returns the definition name.
`java.lang.String` | `getReturnType()` Returns the script type for return.
`java.lang.String` | `getToolTip()` Returns the display string for the tool tip of this method.
`java.lang.String` | `getToolTipKey()` Returns the resource key for tool tip.
`boolean` | `isConstructor()` Returns whether this method is constructor.
`boolean` | `isStatic()` Returns whether this method is static.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### MethodInfo

    protected MethodInfo(java.lang.reflect.Method method)

Parameters:
  `method` -

Method Detail

### getMethod

    protected java.lang.reflect.Method getMethod()

  Returns the internal Java Method instance.

  Returns:
    the internal Java Method instance

### argumentListIterator

    public java.util.Iterator 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 java.lang.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

### getToolTip

    public java.lang.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.

### getDisplayName

    public java.lang.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

### getDisplayNameKey

    public java.lang.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 java.lang.String getName()

  Description copied from interface: `ILocalizableInfo`
  Returns the definition name.

  Specified by:
    `getName` in interface `ILocalizableInfo`
  Returns:
    the name of this definition

### getJavaDoc

    public java.lang.String getJavaDoc()

  Description copied from interface: `IMethodInfo`
  Returns the method javadoc.

  Specified by:
    `getJavaDoc` in interface `IMethodInfo`
  Returns:
    the javadoc

### getReturnType

    public java.lang.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

### 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.