Class CompoundHandler

    • Constructor Detail

      • CompoundHandler

        public CompoundHandler​(java.lang.String xmlDir)
    • Method Detail

      • init

        public static void init()
      • exit

        public static void exit()
      • locationBodyFile

        public java.lang.String locationBodyFile()
        Specified by:
        locationBodyFile in interface IClass
      • name

        public java.lang.String name()
        Description copied from interface: ICompound
        Returns the name of this compound
        Specified by:
        name in interface ICompound
      • id

        public java.lang.String id()
        Description copied from interface: ICompound
        Returns the id of this compound. The id is a unique string representing a specific compound object.
        Specified by:
        id in interface ICompound
      • kindString

        public java.lang.String kindString()
        Description copied from interface: ICompound
        Returns a string representation of the compound kind.
        Specified by:
        kindString in interface ICompound
        See Also:
        ICompound.kind()
      • protection

        public java.lang.String protection()
      • startSection

        public void startSection​(org.xml.sax.Attributes attrib)
      • startBriefDesc

        public void startBriefDesc​(org.xml.sax.Attributes attrib)
      • startDetailedDesc

        public void startDetailedDesc​(org.xml.sax.Attributes attrib)
      • startProgramListing

        public void startProgramListing​(org.xml.sax.Attributes attrib)
      • startIncludes

        public void startIncludes​(org.xml.sax.Attributes attrib)
      • startIncludedBy

        public void startIncludedBy​(org.xml.sax.Attributes attrib)
      • startCompound

        public void startCompound​(org.xml.sax.Attributes attrib)
      • endCompound

        public void endCompound()
      • startLocation

        public void startLocation​(org.xml.sax.Attributes attrib)
      • endCompoundName

        public void endCompoundName()
      • startInnerClass

        public void startInnerClass​(org.xml.sax.Attributes attrib)
      • startInnerNamespace

        public void startInnerNamespace​(org.xml.sax.Attributes attrib)
      • startInnerFile

        public void startInnerFile​(org.xml.sax.Attributes attrib)
      • startInnerGroup

        public void startInnerGroup​(org.xml.sax.Attributes attrib)
      • startInnerPage

        public void startInnerPage​(org.xml.sax.Attributes attrib)
      • startInnerDir

        public void startInnerDir​(org.xml.sax.Attributes attrib)
      • startTemplateParamList

        public void startTemplateParamList​(org.xml.sax.Attributes attrib)
      • startListOfAllMembers

        public void startListOfAllMembers​(org.xml.sax.Attributes attrib)
      • startSuperClass

        public void startSuperClass​(org.xml.sax.Attributes attrib)
      • endSuperClass

        public void endSuperClass()
      • startSubClass

        public void startSubClass​(org.xml.sax.Attributes attrib)
      • endSubClass

        public void endSubClass()
      • startTitle

        public void startTitle​(org.xml.sax.Attributes attrib)
      • parseXML

        public boolean parseXML​(java.lang.String id)
                         throws org.xml.sax.SAXException,
                                java.io.IOException
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
      • initialize

        public void initialize​(MainHandler mh)
      • toICompound

        public ICompound toICompound()
      • release

        public void release()
      • sections

        public java.util.ListIterator<IUserDefined> sections()
        Description copied from interface: ICompound
        Returns an iterator for the different member sections in this compound.
        Specified by:
        sections in interface ICompound
      • memberByName

        public java.util.ListIterator<IMember> memberByName​(java.lang.String name)
        Description copied from interface: ICompound
        Returns a list of all members within the compound having a certain name. Member overloading is the reason why there can be more than one member.
        Specified by:
        memberByName in interface ICompound
        Parameters:
        name - The name of the member.
      • startInheritanceGraph

        public void startInheritanceGraph​(org.xml.sax.Attributes attrib)
      • startCollaborationGraph

        public void startCollaborationGraph​(org.xml.sax.Attributes attrib)
      • startIncludeDependencyGraph

        public void startIncludeDependencyGraph​(org.xml.sax.Attributes attrib)
      • startIncludedByDependencyGraph

        public void startIncludedByDependencyGraph​(org.xml.sax.Attributes attrib)
      • memberById

        public IMember memberById​(java.lang.String id)
        Description copied from interface: ICompound
        Returns an public interface to a member given its id.
        Specified by:
        memberById in interface ICompound
        Parameters:
        id - The member id.
      • includes

        public java.util.ListIterator<IInclude> includes()
        Specified by:
        includes in interface IFile