Class CompoundHandler
- java.lang.Object
-
- org.xml.sax.helpers.DefaultHandler
-
- org.cakelab.jdoxml.impl.basehandler.BaseHandler<CompoundHandler>
-
- org.cakelab.jdoxml.impl.compoundhandler.CompoundHandler
-
- All Implemented Interfaces:
IClass
,ICompound
,IDir
,IDocumentedElement
,IException
,IFile
,IGroup
,IInterface
,INamespace
,IPage
,IStruct
,IUnion
,IBaseHandler
,org.xml.sax.ContentHandler
,org.xml.sax.DTDHandler
,org.xml.sax.EntityResolver
,org.xml.sax.ErrorHandler
public class CompoundHandler extends BaseHandler<CompoundHandler> implements IClass, IStruct, IUnion, IException, IInterface, INamespace, IFile, IGroup, IPage, IDir
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.cakelab.jdoxml.api.ICompound
ICompound.CompoundKind
-
-
Field Summary
Fields Modifier and Type Field Description static CompoundTypeMap
s_typeMap
-
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 CompoundHandler(java.lang.String xmlDir)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.ListIterator<IRelatedCompound>
baseCompounds()
IDocRoot
briefDescription()
Returns a tree-structured representation of the brief description that is attached to this compound.IGraph
collaborationGraph()
java.util.ListIterator<IRelatedCompound>
derivedCompounds()
IDocRoot
detailedDescription()
Returns a tree-structured representation of the detailed description that is attached to this compound.void
endCompound()
void
endCompoundName()
void
endSubClass()
void
endSuperClass()
static void
exit()
java.lang.String
id()
Returns the id of this compound.java.util.ListIterator<IInclude>
includedBy()
IGraph
includedByDependencyGraph()
IGraph
includeDependencyGraph()
java.util.ListIterator<IInclude>
includes()
IGraph
inheritanceGraph()
static void
init()
void
initialize(MainHandler mh)
void
insertMember(MemberHandler mh)
ICompound.CompoundKind
kind()
Returns the kind of compound.java.lang.String
kindString()
Returns a string representation of the compound kind.int
locationBodyEndLine()
java.lang.String
locationBodyFile()
int
locationBodyStartLine()
java.lang.String
locationFile()
int
locationLine()
IMember
memberById(java.lang.String id)
Returns an public interface to a member given its id.java.util.ListIterator<IMember>
memberByName(java.lang.String name)
Returns a list of all members within the compound having a certain name.java.util.ListIterator<IMemberReference>
members()
java.lang.String
name()
Returns the name of this compoundjava.util.ListIterator<ICompound>
nestedCompounds()
boolean
parseXML(java.lang.String id)
java.lang.String
protection()
void
release()
java.util.ListIterator<IUserDefined>
sections()
Returns an iterator for the different member sections in this compound.IDocProgramListing
source()
void
startBriefDesc(org.xml.sax.Attributes attrib)
void
startCollaborationGraph(org.xml.sax.Attributes attrib)
void
startCompound(org.xml.sax.Attributes attrib)
void
startDetailedDesc(org.xml.sax.Attributes attrib)
void
startIncludedBy(org.xml.sax.Attributes attrib)
void
startIncludedByDependencyGraph(org.xml.sax.Attributes attrib)
void
startIncludeDependencyGraph(org.xml.sax.Attributes attrib)
void
startIncludes(org.xml.sax.Attributes attrib)
void
startInheritanceGraph(org.xml.sax.Attributes attrib)
void
startInnerClass(org.xml.sax.Attributes attrib)
void
startInnerDir(org.xml.sax.Attributes attrib)
void
startInnerFile(org.xml.sax.Attributes attrib)
void
startInnerGroup(org.xml.sax.Attributes attrib)
void
startInnerNamespace(org.xml.sax.Attributes attrib)
void
startInnerPage(org.xml.sax.Attributes attrib)
void
startListOfAllMembers(org.xml.sax.Attributes attrib)
void
startLocation(org.xml.sax.Attributes attrib)
void
startProgramListing(org.xml.sax.Attributes attrib)
void
startSection(org.xml.sax.Attributes attrib)
void
startSubClass(org.xml.sax.Attributes attrib)
void
startSuperClass(org.xml.sax.Attributes attrib)
void
startTemplateParamList(org.xml.sax.Attributes attrib)
void
startTitle(org.xml.sax.Attributes attrib)
java.util.ListIterator<IParam>
templateParameters()
IDocTitle
title()
ICompound
toICompound()
-
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
-
-
-
-
Field Detail
-
s_typeMap
public static CompoundTypeMap s_typeMap
-
-
Method Detail
-
init
public static void init()
-
exit
public static void exit()
-
locationFile
public java.lang.String locationFile()
- Specified by:
locationFile
in interfaceIClass
- Specified by:
locationFile
in interfaceIStruct
-
locationLine
public int locationLine()
- Specified by:
locationLine
in interfaceIClass
- Specified by:
locationLine
in interfaceIStruct
-
locationBodyFile
public java.lang.String locationBodyFile()
- Specified by:
locationBodyFile
in interfaceIClass
-
locationBodyStartLine
public int locationBodyStartLine()
- Specified by:
locationBodyStartLine
in interfaceIClass
- Specified by:
locationBodyStartLine
in interfaceIStruct
-
locationBodyEndLine
public int locationBodyEndLine()
- Specified by:
locationBodyEndLine
in interfaceIClass
- Specified by:
locationBodyEndLine
in interfaceIStruct
-
name
public java.lang.String name()
Description copied from interface:ICompound
Returns the name of this compound
-
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.
-
kind
public ICompound.CompoundKind kind()
Description copied from interface:ICompound
Returns the kind of compound. See #CompoundKind for possible values.
-
kindString
public java.lang.String kindString()
Description copied from interface:ICompound
Returns a string representation of the compound kind.- Specified by:
kindString
in interfaceICompound
- 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)
-
insertMember
public void insertMember(MemberHandler 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.
-
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 interfaceICompound
- 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)
-
briefDescription
public IDocRoot briefDescription()
Description copied from interface:ICompound
Returns a tree-structured representation of the brief description that is attached to this compound.- Specified by:
briefDescription
in interfaceICompound
- Specified by:
briefDescription
in interfaceIDocumentedElement
-
detailedDescription
public IDocRoot detailedDescription()
Description copied from interface:ICompound
Returns a tree-structured representation of the detailed description that is attached to this compound.- Specified by:
detailedDescription
in interfaceICompound
- Specified by:
detailedDescription
in interfaceIDocumentedElement
-
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 interfaceICompound
- Parameters:
id
- The member id.
-
inheritanceGraph
public IGraph inheritanceGraph()
- Specified by:
inheritanceGraph
in interfaceIClass
-
collaborationGraph
public IGraph collaborationGraph()
- Specified by:
collaborationGraph
in interfaceIClass
-
includeDependencyGraph
public IGraph includeDependencyGraph()
- Specified by:
includeDependencyGraph
in interfaceIFile
-
includedByDependencyGraph
public IGraph includedByDependencyGraph()
- Specified by:
includedByDependencyGraph
in interfaceIFile
-
baseCompounds
public java.util.ListIterator<IRelatedCompound> baseCompounds()
- Specified by:
baseCompounds
in interfaceIClass
- Specified by:
baseCompounds
in interfaceIInterface
- Specified by:
baseCompounds
in interfaceIStruct
-
derivedCompounds
public java.util.ListIterator<IRelatedCompound> derivedCompounds()
- Specified by:
derivedCompounds
in interfaceIClass
- Specified by:
derivedCompounds
in interfaceIInterface
- Specified by:
derivedCompounds
in interfaceIStruct
-
nestedCompounds
public java.util.ListIterator<ICompound> nestedCompounds()
- Specified by:
nestedCompounds
in interfaceIClass
- Specified by:
nestedCompounds
in interfaceIDir
- Specified by:
nestedCompounds
in interfaceIFile
- Specified by:
nestedCompounds
in interfaceIGroup
- Specified by:
nestedCompounds
in interfaceINamespace
- Specified by:
nestedCompounds
in interfaceIStruct
- Specified by:
nestedCompounds
in interfaceIUnion
-
source
public IDocProgramListing source()
-
includes
public java.util.ListIterator<IInclude> includes()
-
includedBy
public java.util.ListIterator<IInclude> includedBy()
- Specified by:
includedBy
in interfaceIFile
-
templateParameters
public java.util.ListIterator<IParam> templateParameters()
- Specified by:
templateParameters
in interfaceIClass
-
members
public java.util.ListIterator<IMemberReference> members()
-
-