javaMethodArray

The <javaMethodArray> element specifies a parameter or return value of the method or constructor as an array.

Description

Array objects encapsulate a group of variables that do not have individual names. The values are accessed by using positive integer index values.

Example

Click on the following link to open the Java API topic type example in
<javaMethod id="com.ibm.xtools.pluglets.engine.PlugletException">
   <apiName>getIntArray</apiName>
   <shortdesc>Retrieves the contents of the SQL array designated by the object.</shortdesc>
   <javaMethodDetail>
     <javaMethodDef>
       <javaMethodAccess value="public"/>
       <javaReturn>
         <javaMethodPrimitive name="type" value="int"/>
         <javaMethodArray value="1"/>
         <apiDefNote>An array containing count elements starting at index.</apiDefNote>
       </javaReturn>
       <javaParam>
          <javaMethodPrimitive value="long"/>
          <apiItemName>index</apiItemName>
          <apiDefNote>the index of first element to be returned.</apiDefNote>
       </javaParam>
       <javaParam>
          <javaMethodPrimitive value="int"/>
          <apiItemName>count</apiItemName>
          <apiDefNote>the number of elements to be returned.</apiDefNote>
       </javaParam>
     </javaMethodDef>
   </javaMethodDetail>
</javaMethod>

Processing Expectations

Contained by

javaParam, javaReturn

Content model

no content

Inheritance

topic/state reference/state apiRef/apiArray apiOperation/apiArray