Class MainHandler

    • Constructor Detail

      • MainHandler

        public MainHandler()
    • 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 interface IDoxygen
      • 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 interface IDoxygen
        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.
        Specified by:
        compounds in interface IDoxygen
      • 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 interface IDoxygen
      • 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 interface IDoxygen
      • 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 interface IDoxygen
        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 interface IDoxygen
        Parameters:
        name - The name of the member.
      • createObjectModel

        public static IDoxygen createObjectModel()
      • release

        public void release()
        Description copied from interface: IDoxygen
        Releases the memory for the object hierarchy obtained by createdObjecModelFromXML(). First release all iterators before calling this function.
        Specified by:
        release in interface IDoxygen