public interface IDITAList
Modifier and Type | Method and Description |
---|---|
IASDocComment |
getComment(IDefinition definition)
Returns an
IASDocComment for the given IDefinition we are looking for. |
List<IDITAEntry> |
getEntries()
Returns all of the
IDITAEntry elements contained within this SWC |
IDITAEntry |
getEntry(String packageName)
Returns the IDITAEntry for the given package.
|
boolean |
hasEntries()
Returns true if this list contains any entries
|
List<IDITAEntry> getEntries()
IDITAEntry
elements contained within this SWCboolean hasEntries()
IDITAEntry getEntry(String packageName)
packageName
- the package name we want to find an IDITAEntry
forIDITAEntry
or nullIASDocComment getComment(IDefinition definition) throws Exception
IASDocComment
for the given IDefinition
we are looking for. This method will first check for a matching package entry based on the information
in the IDefinition
, and seek in appropriately. This is a convenience method for first calling getEntry, and then getComment(IDefinition)
definition
- the IDefinition
we are looking atIASDocComment
or nullException
- an exception if any errors occur. These can include IO errors among othersCopyright © 2016 The Apache Software Foundation. All rights reserved.