Package org.eclipse.steady

Class DirAnalyzer

java.lang.Object

org.eclipse.steady.DirAnalyzer

All Implemented Interfaces:

FileAnalyzer

public class DirAnalyzer
extends Object
implements FileAnalyzer

Analyzes all files below a given directory, thereby using other implementations of FileAnalyzer.

Constructor Summary

Constructors

Constructor	Description
DirAnalyzer()

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.
static FileAnalyzer	createAnalyzerForArchiveEntry(InputStream _is, String _entry)	The given InputStream has been created from an archive entry with the given name.
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.
void	setExtensionFilter(String[] _exts)	Setter for the field extensionFilter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.steady.FileAnalyzer

equals, hashCode

Constructor Detail

DirAnalyzer

public DirAnalyzer()

Method Detail

setExtensionFilter

public void setExtensionFilter(String[] _exts)

Setter for the field extensionFilter.

Parameters:

_exts - an array of String objects.

getSupportedFileExtensions

public String[] getSupportedFileExtensions()

Returns all supported file extensions.

Specified by:

getSupportedFileExtensions in interface FileAnalyzer

Returns:

an array of String objects.

canAnalyze

public boolean canAnalyze(File _file)

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

Specified by:

canAnalyze in interface FileAnalyzer

Parameters:

_file - a File object.

Returns:

a boolean.

analyze

public void analyze(File _file)
             throws FileAnalysisException

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

Specified by:

analyze in interface FileAnalyzer

Parameters:

_file - a File object.

Throws:

FileAnalysisException - if any.

getConstructs

public 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 the union of constructs of all FileAnalyzers created when searching recursivly in the directory.

Specified by:

getConstructs in interface FileAnalyzer

Returns:

a Map object.

Throws:

FileAnalysisException - if any.

containsConstruct

public boolean containsConstruct(ConstructId _id)
                          throws FileAnalysisException

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

Specified by:

containsConstruct in interface FileAnalyzer

Parameters:

_id - a ConstructId object.

Returns:

a boolean.

Throws:

FileAnalysisException - if any.

getConstruct

public 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.

Specified by:

getConstruct in interface FileAnalyzer

Parameters:

_id - a ConstructId object.

Returns:

a Construct object.

Throws:

FileAnalysisException - if any.

hasChilds

public 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.

Specified by:

hasChilds in interface FileAnalyzer

Returns:

a boolean.

getChilds

public 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.

Specified by:

getChilds in interface FileAnalyzer

Parameters:

_recursive - a boolean.

Returns:

a Set object.

createAnalyzerForArchiveEntry

public static FileAnalyzer createAnalyzerForArchiveEntry(InputStream _is,
                                                         String _entry)

The given InputStream has been created from an archive entry with the given name. The entry is extracted below the temporary directory, and a FileAnalyzer is created for it.

Parameters:

_is - a InputStream object.

_entry - a String object.

Returns:

a FileAnalyzer object.