Class MainHandler
- java.lang.Object
-
- org.xml.sax.helpers.DefaultHandler
-
- org.cakelab.jdoxml.impl.basehandler.BaseHandler<MainHandler>
-
- org.cakelab.jdoxml.impl.mainhandler.MainHandler
-
- All Implemented Interfaces:
IDoxygen
,IBaseHandler
,org.xml.sax.ContentHandler
,org.xml.sax.DTDHandler
,org.xml.sax.EntityResolver
,org.xml.sax.ErrorHandler
public class MainHandler extends BaseHandler<MainHandler> implements IDoxygen
-
-
Field Summary
-
Fields inherited from class org.cakelab.jdoxml.impl.basehandler.BaseHandler
elementMapper, m_curString, m_delegateHandler, m_fallBackHandler, m_skipCount, m_skipUntil, s_theLocator
-
-
Constructor Summary
Constructors Constructor Description MainHandler()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ICompound
compoundById(java.lang.String id)
Returns a compound given its unique \a id.ICompound
compoundByName(java.lang.String name)
Returns a compound given its name (including the scope).java.util.ListIterator<ICompound>
compounds()
Returns an iterator that can be used to iterate over the list of compounds found in the project.static IDoxygen
createObjectModel()
void
dump()
void
endMember()
void
endName()
ICompound
memberById(java.lang.String id)
Returns an public interface to a compound containing a member given it the member's id.java.util.ListIterator<ICompound>
memberByName(java.lang.String name)
Returns a list of all compounds containing at least one members with a certain name.void
readXMLDir(java.io.File xmlDir)
Reads an XML directory produced by doxygen and builds up a data structure representing the contents of the XML files in the directory.void
release()
Releases the memory for the object hierarchy obtained by createdObjecModelFromXML().void
setDebugLevel(int level)
Sets the debug level.void
startCompound(org.xml.sax.Attributes attrib)
void
startMember(org.xml.sax.Attributes attrib)
void
startName(org.xml.sax.Attributes attrib)
void
unloadCompound(CompoundHandler ch)
-
Methods inherited from class org.cakelab.jdoxml.impl.basehandler.BaseHandler
addEndHandler, addEndHandler, addStartHandler, addStartHandler, characters, delegate, endElement, fallBackHandler, setDelegate, setDocumentLocator, setFallBackHandler, skippedEntity, startDocument, startElement
-
Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, startPrefixMapping, unparsedEntityDecl, warning
-
-
-
-
Method Detail
-
startCompound
public void startCompound(org.xml.sax.Attributes attrib)
-
startName
public void startName(org.xml.sax.Attributes attrib)
-
endName
public void endName()
-
startMember
public void startMember(org.xml.sax.Attributes attrib)
-
endMember
public void endMember()
-
setDebugLevel
public void setDebugLevel(int level)
Description copied from interface:IDoxygen
Sets the debug level. - 0 all debugging messages are disabled (the default). - 1 display important messages only - 2 display any messages.- Specified by:
setDebugLevel
in interfaceIDoxygen
-
dump
public void dump()
-
readXMLDir
public void readXMLDir(java.io.File xmlDir) throws org.xml.sax.SAXException, java.io.IOException
Description copied from interface:IDoxygen
Reads an XML directory produced by doxygen and builds up a data structure representing the contents of the XML files in the directory.- Specified by:
readXMLDir
in interfaceIDoxygen
- Throws:
org.xml.sax.SAXException
java.io.IOException
-
compounds
public java.util.ListIterator<ICompound> compounds()
Description copied from interface:IDoxygen
Returns an iterator that can be used to iterate over the list of compounds found in the project.
-
compoundById
public ICompound compoundById(java.lang.String id)
Description copied from interface:IDoxygen
Returns a compound given its unique \a id. If you have a compound id this function is much more efficient than iterating over the compound list. Returns 0 if the id is not valid.- Specified by:
compoundById
in interfaceIDoxygen
-
unloadCompound
public void unloadCompound(CompoundHandler ch)
-
compoundByName
public ICompound compoundByName(java.lang.String name)
Description copied from interface:IDoxygen
Returns a compound given its name (including the scope). Returns 0 if the name is not found in the project.- Specified by:
compoundByName
in interfaceIDoxygen
-
memberById
public ICompound memberById(java.lang.String id)
Description copied from interface:IDoxygen
Returns an public interface to a compound containing a member given it the member's id. Given the ICompound public interface one can use the same id to obtain the IMember public interface.- Specified by:
memberById
in interfaceIDoxygen
- Parameters:
id
- The member id.
-
memberByName
public java.util.ListIterator<ICompound> memberByName(java.lang.String name)
Description copied from interface:IDoxygen
Returns a list of all compounds containing at least one members with a certain name. Each compound can be asked to return the list of members with that name.- Specified by:
memberByName
in interfaceIDoxygen
- Parameters:
name
- The name of the member.
-
createObjectModel
public static IDoxygen createObjectModel()
-
-