Package org.eclipse.steady

Interface FileAnalyzer

All Known Implementing Classes:

DirAnalyzer

public interface FileAnalyzer

Analyzes a given file or directory in order to search for contained programming constructs. Instances of FileAnalyzer are built by FileAnalyzerFactory. FileAnalyzers can be nested and form a tree structure, which is addressed by methods hasChilds() and getChilds(boolean).

Method Summary

Modifier and Type	Method	Description
void	analyze(File _file)	Sets the File to be analyzed.
boolean	canAnalyze(File _file)	Returns true if the given File can be analyzed, false otherwise.
boolean	containsConstruct(ConstructId _id)	Returns true if the given ConstructId is part of the analyzed file, false otherwise.
boolean	equals(Object obj)
Set<FileAnalyzer>	getChilds(boolean _recursive)	Returns nested FileAnalyzers or null if no child analyzers exist.
Construct	getConstruct(ConstructId _id)	Returns the Construct with the given ConstructId or null if no such construct is present in the analyzed file.
Map<ConstructId,Construct>	getConstructs()	Searches for programming Constructs contained in a given File and returns them to the caller.
String[]	getSupportedFileExtensions()	Returns all supported file extensions.
boolean	hasChilds()	Returns true if there are any child FileAnalyzers, false otherwise.
int	hashCode()

Method Detail

getSupportedFileExtensions

String[] getSupportedFileExtensions()

Returns all supported file extensions.

Returns:

an array of String objects.

canAnalyze

boolean canAnalyze(File _file)

Returns true if the given File can be analyzed, false otherwise.

Parameters:

_file - a File object.

Returns:

a boolean.

analyze

void analyze(File _file)
      throws FileAnalysisException

Sets the File to be analyzed. Note that this does not necessarily trigger the analysis.

Parameters:

_file - a File object.

Throws:

FileAnalysisException - if any.

getConstructs

Map<ConstructId,Construct> getConstructs()
                                        throws FileAnalysisException

Searches for programming Constructs contained in a given File and returns them to the caller. The File to be analyzed is not specified using the methods of the interface. Typically, it is passed to the constructor of the respective implementation.

Returns:

a Map object.

Throws:

FileAnalysisException - if any.

containsConstruct

boolean containsConstruct(ConstructId _id)
                   throws FileAnalysisException

Returns true if the given ConstructId is part of the analyzed file, false otherwise.

Parameters:

_id - a ConstructId object.

Returns:

a boolean.

Throws:

FileAnalysisException - if any.

getConstruct

Construct getConstruct(ConstructId _id)
                throws FileAnalysisException

Returns the Construct with the given ConstructId or null if no such construct is present in the analyzed file.

Parameters:

_id - a ConstructId object.

Returns:

a Construct object.

Throws:

FileAnalysisException - if any.

hasChilds

boolean hasChilds()

Returns true if there are any child FileAnalyzers, false otherwise. Some analyzers will never have any childs, e.g., those that parse single source code files. In case of other analyzes, e.g., the DirAnalyzer, it depends on whether there are any "analyzable" files.

Returns:

a boolean.

getChilds

Set<FileAnalyzer> getChilds(boolean _recursive)

Returns nested FileAnalyzers or null if no child analyzers exist. Depending on the argument, only direct childs or also indirect childs will be returned.

Parameters:

_recursive - a boolean.

Returns:

a Set object.

hashCode

int hashCode()

Overrides:

hashCode in class Object

equals

boolean equals(Object obj)

Overrides:

equals in class Object