javaInterface

The <javaInterface> element provides the name of the API interface that you are describing and all the elements necessary to describe the interface.

Description

The <javaInterface> element requires an ID attribute as an anchor point. This ID is the target for references by keyref and for internal applications that refer to the <javaInterface> element content. Use the unique key such as a fully qualified interface name (for example, com.ibm.xtools.patterns.core.IparameterDescriptor) for the named API reference. The <apiName>, <shortdesc> and <javaInterfaceDetail> are the required elements for this top-level container.

Contained by

javaClass

Contains

apiName, javaField, javaInterfaceDetail, javaMethod, prolog, related-links, shortdesc

Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (javaInterfaceDetail) then (related-links) (optional) then (javaMethod or javaField) (any number))

Inheritance

topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier