com.objectwave.sourceParser
Interface ClassParser

All Known Implementing Classes:

ClassSpecParser, MethodDefParser, MethodDetailParser, PackageDefParser, VariableDefParser

public interface ClassParser

A class that can parse source code by the source code reader must implment this interface.

Author:

Dave Hoag

Method Summary

void	finishParsing(java.lang.StringBuffer buf, java.lang.String[] identifier, java.io.Reader rdr) We've accepted ownership of parsing ths source code, now finish the job.
ClassElement	getDataObject() When we have finished parsing, the resulting ClassElement returned by getDataObject should represent our meta-model of that element.
boolean	isMyArea(java.lang.String identifier) When parsing source code we never know what ClassElement will be next, so we ask all possible class elements isMyArea(String) for one of them to say yes.

Method Detail

finishParsing

public void finishParsing(java.lang.StringBuffer buf,
                          java.lang.String[] identifier,
                          java.io.Reader rdr)
                   throws java.io.IOException

We've accepted ownership of parsing ths source code, now finish the job.

java.io.IOException

getDataObject

public ClassElement getDataObject()

When we have finished parsing, the resulting ClassElement returned by getDataObject should represent our meta-model of that element.

isMyArea

public boolean isMyArea(java.lang.String identifier)

When parsing source code we never know what ClassElement will be next, so we ask all possible class elements isMyArea(String) for one of them to say yes. Once one of the parser acknowledges ownership, we hand off the parsing routine to that class parser.

See Also:

finishParsing(java.lang.StringBuffer, java.lang.String[], java.io.Reader)