mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-04-23 14:42:11 +02:00
Bug 279155 Tweak JavaDoc on #findFileName
This commit is contained in:
parent
81281de742
commit
2c8724af33
1 changed files with 16 additions and 7 deletions
|
@ -326,18 +326,27 @@ public class ErrorParserManager extends OutputStream {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the file with the given name if that file can be uniquely identified.
|
* Returns the file with the given (partial) location if that file can be uniquely identified.
|
||||||
* Otherwise returns {@code null}.
|
* Otherwise returns {@code null}.
|
||||||
|
* <br><br>
|
||||||
|
* The passed in String 'partialLoc' is treated as a partial filesystem location for the
|
||||||
|
* resource. Resolution is attempted with the following precedence:<br>
|
||||||
|
* If partialLoc is an absolute fs location:<br>
|
||||||
|
* - Resolve it to an IFile in the Project<br>
|
||||||
|
* - Resolve it to an IFile in the Workspace<br>
|
||||||
|
* If partialLoc is a relative path:<br>
|
||||||
|
* - Resolve it relative to the Current Working Directory<br>
|
||||||
|
* - Resolve just the segments provided<br>
|
||||||
*
|
*
|
||||||
* @param fileName - file name could be plain file name, absolute path or partial path
|
* @param partialLoc - file name could be plain file name, absolute path or partial path
|
||||||
* @return - file in the workspace or {@code null}.
|
* @return - file in the workspace or {@code null}.
|
||||||
*/
|
*/
|
||||||
public IFile findFileName(String fileName) {
|
public IFile findFileName(String partialLoc) {
|
||||||
if (fileName.equals(cachedFileName) && cachedWorkingDirectory != null &&
|
if (partialLoc.equals(cachedFileName) && cachedWorkingDirectory != null &&
|
||||||
org.eclipse.core.filesystem.URIUtil.equals(getWorkingDirectoryURI(), cachedWorkingDirectory))
|
org.eclipse.core.filesystem.URIUtil.equals(getWorkingDirectoryURI(), cachedWorkingDirectory))
|
||||||
return cachedFile;
|
return cachedFile;
|
||||||
|
|
||||||
IPath path = new Path(fileName);
|
IPath path = new Path(partialLoc);
|
||||||
|
|
||||||
// Try to find exact match. If path is not absolute - searching in working directory.
|
// Try to find exact match. If path is not absolute - searching in working directory.
|
||||||
IFile file = findFileInWorkspace(path);
|
IFile file = findFileInWorkspace(path);
|
||||||
|
@ -360,10 +369,10 @@ public class ErrorParserManager extends OutputStream {
|
||||||
|
|
||||||
// Could be cygwin path
|
// Could be cygwin path
|
||||||
if (file==null && isCygwin && path.isAbsolute()) {
|
if (file==null && isCygwin && path.isAbsolute()) {
|
||||||
file = findCygwinFile(fileName);
|
file = findCygwinFile(partialLoc);
|
||||||
}
|
}
|
||||||
|
|
||||||
cachedFileName = fileName;
|
cachedFileName = partialLoc;
|
||||||
cachedWorkingDirectory = getWorkingDirectoryURI();
|
cachedWorkingDirectory = getWorkingDirectoryURI();
|
||||||
cachedFile = file;
|
cachedFile = file;
|
||||||
return file;
|
return file;
|
||||||
|
|
Loading…
Add table
Reference in a new issue