javaMethodInterface

The <javaMethodInterface> element identifies the name of the returned value of the method or constructor when the return value is an interface.

Description

A method declaration either specifies the type of value that the method returns or uses the keyword void to indicate that the method does not return a value.

This element has the following attributes: href, keyref, type, format, scope(local | peer | external), and outputclass. The keyref attribute must provide a unique key such as a fully qualified class name for the named API item.

Possible alternative definitions of the <javaMethodInterface> element are the javaMethodClass, javaMethodPrimitive, javaMethodArray, and javaVoid elements. This element is the specialization of the apiOperationClassifier element from the generic topic type.

Example

Click on the following link to open the Java API topic type example in
<javaMethod id="com.ibm.xtools.ras.impord.engine.tasks.IImportEngineTask">
   <apiName>execute</apiName>
   <shortdesc>Execute the task.</shortdesc>
   <javaMethodDetail>
     <javaMethodDef>
         <javaReturnInterface keyref=”IStatus”>
             IStatus
         </javaReturnInterface>
         <apiDefNote>
             <p>atus returns the status. The severity is
             <ul><li>IStatus.OK if the task executed without any problems
                <li>IStatus.INFO if the task executed successfully, but there were
                    messages to report to the end user
                <li>IStatus.WARNING if the task executed successfully, however
                    there are warnings reported or non-fatal errors. </li>
                <li>IStatus.ERROR if there are errors during the
                    execution of the task that cause the import
                    to be aborted</li>
             </ul></p>
          </apiDefNote>
         <javaMethodAccess value=”public”/>
     </javaMethodDef>
</javaMethod>

Processing Expectations

Contained by

javaParam, javaReturn

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier