public class CompoundHandler extends BaseHandler<CompoundHandler> implements IClass, IStruct, IUnion, IException, IInterface, INamespace, IFile, IGroup, IPage, IDir
ICompound.CompoundKind
Modifier and Type | Field and Description |
---|---|
static CompoundTypeMap |
s_typeMap |
elementMapper, m_curString, m_delegateHandler, m_fallBackHandler, m_skipCount, m_skipUntil, s_theLocator
Constructor and Description |
---|
CompoundHandler(java.lang.String xmlDir) |
Modifier and Type | Method and 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 compound
|
java.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() |
addEndHandler, addEndHandler, addStartHandler, addStartHandler, characters, delegate, endElement, fallBackHandler, setDelegate, setDocumentLocator, setFallBackHandler, skippedEntity, startDocument, startElement
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, startPrefixMapping, unparsedEntityDecl, warning
public static CompoundTypeMap s_typeMap
public static void init()
public static void exit()
public java.lang.String locationFile()
locationFile
in interface IClass
locationFile
in interface IStruct
public int locationLine()
locationLine
in interface IClass
locationLine
in interface IStruct
public java.lang.String locationBodyFile()
locationBodyFile
in interface IClass
public int locationBodyStartLine()
locationBodyStartLine
in interface IClass
locationBodyStartLine
in interface IStruct
public int locationBodyEndLine()
locationBodyEndLine
in interface IClass
locationBodyEndLine
in interface IStruct
public java.lang.String name()
ICompound
public java.lang.String id()
ICompound
public ICompound.CompoundKind kind()
ICompound
public java.lang.String kindString()
ICompound
kindString
in interface ICompound
ICompound.kind()
public java.lang.String protection()
public void startSection(org.xml.sax.Attributes attrib)
public void startBriefDesc(org.xml.sax.Attributes attrib)
public void startDetailedDesc(org.xml.sax.Attributes attrib)
public void startProgramListing(org.xml.sax.Attributes attrib)
public void startIncludes(org.xml.sax.Attributes attrib)
public void startIncludedBy(org.xml.sax.Attributes attrib)
public void startCompound(org.xml.sax.Attributes attrib)
public void endCompound()
public void startLocation(org.xml.sax.Attributes attrib)
public void endCompoundName()
public void startInnerClass(org.xml.sax.Attributes attrib)
public void startInnerNamespace(org.xml.sax.Attributes attrib)
public void startInnerFile(org.xml.sax.Attributes attrib)
public void startInnerGroup(org.xml.sax.Attributes attrib)
public void startInnerPage(org.xml.sax.Attributes attrib)
public void startInnerDir(org.xml.sax.Attributes attrib)
public void startTemplateParamList(org.xml.sax.Attributes attrib)
public void startListOfAllMembers(org.xml.sax.Attributes attrib)
public void startSuperClass(org.xml.sax.Attributes attrib)
public void endSuperClass()
public void startSubClass(org.xml.sax.Attributes attrib)
public void endSubClass()
public void startTitle(org.xml.sax.Attributes attrib)
public boolean parseXML(java.lang.String id) throws org.xml.sax.SAXException, java.io.IOException
org.xml.sax.SAXException
java.io.IOException
public void initialize(MainHandler mh)
public void insertMember(MemberHandler mh)
public ICompound toICompound()
public void release()
public java.util.ListIterator<IUserDefined> sections()
ICompound
public java.util.ListIterator<IMember> memberByName(java.lang.String name)
ICompound
memberByName
in interface ICompound
name
- The name of the member.public void startInheritanceGraph(org.xml.sax.Attributes attrib)
public void startCollaborationGraph(org.xml.sax.Attributes attrib)
public void startIncludeDependencyGraph(org.xml.sax.Attributes attrib)
public void startIncludedByDependencyGraph(org.xml.sax.Attributes attrib)
public IDocRoot briefDescription()
ICompound
briefDescription
in interface ICompound
briefDescription
in interface IDocumentedElement
public IDocRoot detailedDescription()
ICompound
detailedDescription
in interface ICompound
detailedDescription
in interface IDocumentedElement
public IMember memberById(java.lang.String id)
ICompound
memberById
in interface ICompound
id
- The member id.public IGraph inheritanceGraph()
inheritanceGraph
in interface IClass
public IGraph collaborationGraph()
collaborationGraph
in interface IClass
public IGraph includeDependencyGraph()
includeDependencyGraph
in interface IFile
public IGraph includedByDependencyGraph()
includedByDependencyGraph
in interface IFile
public java.util.ListIterator<IRelatedCompound> baseCompounds()
baseCompounds
in interface IClass
baseCompounds
in interface IInterface
baseCompounds
in interface IStruct
public java.util.ListIterator<IRelatedCompound> derivedCompounds()
derivedCompounds
in interface IClass
derivedCompounds
in interface IInterface
derivedCompounds
in interface IStruct
public java.util.ListIterator<ICompound> nestedCompounds()
nestedCompounds
in interface IClass
nestedCompounds
in interface IDir
nestedCompounds
in interface IFile
nestedCompounds
in interface IGroup
nestedCompounds
in interface INamespace
nestedCompounds
in interface IStruct
nestedCompounds
in interface IUnion
public IDocProgramListing source()
public java.util.ListIterator<IInclude> includes()
public java.util.ListIterator<IInclude> includedBy()
includedBy
in interface IFile
public java.util.ListIterator<IParam> templateParameters()
templateParameters
in interface IClass
public java.util.ListIterator<IMemberReference> members()