javaMethodClass

The <javaMethodClass> element is used to identify the exception thrown when a compile-time error occurs.

Description

Exceptions that are represented by the subclasses of class Error, for example OutOfMemoryError, are thrown due to a failure in or of the virtual machine.

Throws:
                throws ClassType, ClassTypeList

The keyref attribute must provide a unique key such as a fully qualified class name for the named API item.

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>getManifest()</apiName>
   <shortDesc>Get the asset's manifest in the latest supported format.</shortDesc>
   <javaMethodDetail>
      <javaMethodDef>
         <javaFinalMethod/>
         <javaMethodAccess value="public"/>
         <javaRetur>
              <javaMethodClass href=”http://java.sun.com/j2se/org/w3c/dom/Document.html”
                          format=”html” scope=”external”>
              Document
              </javaMethodClass>
              <apiDefNote>the manifest</apiDefNote>
          </javaRetur>
          <javaException>
              <javaMethodClass href=”http://java.sun.com/j2se/io/IOException.html”
                              format=”html” scope=”external”>
              IOException
              </javaMethodClass>
              <apiDefNote>if an error occured retrieving the manifest</apiDefNote>
              <javaMethodClass href=”http://java.sun.com/j2se/io/NullPointerException.html”
                              format=”html” scope=”external”>
              NullPointerException
              </javaMethodClass>
              <apiDefNote>if an error occured retrieving the manifest because an argument was null
              </apiDefNote>
           </javaException>
      </javaMethodDef>
      <apiDesc>This method will take care of updating the profile to the latest version supported.</apiDesc>
   </javaMethodDetail>
 </javaMethod>

Processing Expectations

Contained by

javaException, javaParam, javaReturn

Content model

(text data) (any number)

Inheritance

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