org.schmant.plugin.eclipse.java
Interface ClasspathFileParser

All Known Implementing Classes:

ClasspathFileParserImpl

public interface ClasspathFileParser

This interface defines a parser for Eclipse Java project .classpath files.

Parser objects are reused and can potentially be used simultaneously by several threads, so they cannot contain any mutable internal state that is not properly guarded.

The ClasspathFileParserImpl class has a list of names of user libraries that are ignored if they occur in a project's .classpath file.

Since:

0.5

Author:

Karl Gustafsson

Task_package:

org.schmant.task.base

Method Summary

EclipseProjectClasspathInfo

parse(ReadableFile f, EclipseWorkspace ewos, EntityRepository wosRoot, DirectoryView projRoot, EclipseWorkspaceSettings settings, EclipseWorkspaceConfiguration parsedSettings) Parse a .classpath file and return classpath information from it.

Method Detail

parse

EclipseProjectClasspathInfo parse(ReadableFile f,
                                  EclipseWorkspace ewos,
                                  EntityRepository wosRoot,
                                  DirectoryView projRoot,
                                  EclipseWorkspaceSettings settings,
                                  EclipseWorkspaceConfiguration parsedSettings)
                                  throws IOException

Parse a .classpath file and return classpath information from it.

Parameters:

f - The classpath file.

ewos - The Eclipse workspace. No methods may be called on this object since it is not fully initialized yet. See EclipseWorkspaceInfoCollector.collect(EclipseWorkspace).

wosRoot - The workspace's root directory.

projRoot - The project's directory.

settings - Eclipse workspace settings. May be null.

parsedSettings - Eclipse workspace settings parsed from the workspace metadata. User-supplied settings in the settings object (if any) should override these settings.

Returns:

Classpath information.

Throws:

IOException - On I/O errors.