1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00

Spelling in comments

This commit is contained in:
Andrew Gvozdev 2012-06-24 06:26:59 -04:00
parent 2e05e421b3
commit 097db8838f
2 changed files with 38 additions and 38 deletions

View file

@ -30,7 +30,7 @@ public class GCCBuiltinSpecsDetectorCygwin extends GCCBuiltinSpecsDetector {
try {
CYGWIN_ROOT = new URI("cygwin:/"); //$NON-NLS-1$
} catch (URISyntaxException e) {
// hey we know this works
// hey we know this URI works
throw new IllegalStateException(e);
}
}

View file

@ -18,29 +18,29 @@ import org.eclipse.core.runtime.URIUtil;
/**
* Abstract class providing the basis for supplementary support classes that can extract meaningful
* information from and provide useful operations on EFS filesystems. This allows for operations that can
* operate on virtual EFS filesystems (where IFileStores are just links to other IFileStores), or that operate
* information from and provide useful operations on EFS file-systems. This allows for operations that can
* operate on virtual EFS file-systems (where IFileStores are just links to other IFileStores), or that operate
* on the physical file backed by an IFileStore, without having to know the implementation details of a given
* EFS filesystem.
*
* Provides a default implementation that assumes that URIs for the given filesystem map directly to resources
* in the physical filesystem, and that the path component of the URI is a direct representation of the
* absolute path to the file in the physical filesystem.
*
* Clients wishing to support a filesystem with different behaviour should extend this class and override its
* EFS file-system.
*
* Provides a default implementation that assumes that URIs for the given file-system map directly to resources
* in the physical file-system, and that the path component of the URI is a direct representation of the
* absolute path to the file in the physical file-system.
*
* Clients wishing to support a file-system with different behavior should extend this class and override its
* methods where appropriate.
*
*
* Clients should not typically call methods on this class or its descendants directly. Instead, they should
* call the appropriate method in FileSystemUtilityManager so that said manager can properly route calls to
* the proper utility, depending on the filesystem.
*
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as part of a work in progress. There
* is no guarantee that this API will work or that it will remain the same. Please do not use this API without
* the proper utility, depending on the file-system.
*
* <strong>EXPERIMENTAL</strong>. This class or interface has been added to CDT 7.0 as part of a work in progress.
* There is no guarantee that this API will work or that it will remain the same. Please do not use this API without
* consulting with the CDT team.
*
*
* @author crecoskie
* @since 5.2
*
*
*/
public abstract class EFSExtensionProvider {
@ -48,7 +48,7 @@ public abstract class EFSExtensionProvider {
* If the EFS store represented by locationURI is backed by a physical file, gets the path corresponding
* to the underlying file as the operating system on hosting machine would see it. In the future, it would
* be better if EFS had an API for this.
*
*
* @param locationURI
* @return String representing the path, or <code>null</code> if there is an error or if there is no such
* physical file.
@ -58,10 +58,10 @@ public abstract class EFSExtensionProvider {
}
/**
* In the case of a virtual filesystem, where URIs in the given filesystem are just soft links in EFS to
* URIs in other filesystems, returns the URI that this URI links to. If the filesystem is not virtual,
* In the case of a virtual file-system, where URIs in the given file-system are just soft links in EFS to
* URIs in other file-systems, returns the URI that this URI links to. If the file-system is not virtual,
* then this method acts as an identity mapping.
*
*
* @param locationURI
* @return A URI corresponding to the linked store, or <code>null</code> on error.
*/
@ -73,19 +73,19 @@ public abstract class EFSExtensionProvider {
* Creates a new URI which clones the contents of the original URI, but with the path replaced by the
* given absolute path, such that calling getPathFromURI() on the returned URI will return the given path. Returns
* null on error.
*
*
* The default implementation places the path in the path field of the URI, ensuring that there is a leading slash.
* It also determines whether or not to convert backslashes in the provided path based on whether or not the
* local operating system's file separator is a backslash, thus ensuring proper behaviour for URIs corresponding
* to the local filesystem.
*
* to the local file-system.
*
* @param locationOnSameFilesystem
* @param path An absolute path.
* @return URI
*/
public URI createNewURIFromPath(URI locationOnSameFilesystem, String path) {
URI uri = locationOnSameFilesystem;
Path p = new Path(path);
String pathString = p.toString(); // to convert any backslashes to slashes if we are on Windows
final int length = pathString.length();
@ -99,9 +99,9 @@ public abstract class EFSExtensionProvider {
if (pathString.startsWith("//")) //$NON-NLS-1$
pathBuf.append('/').append('/');
pathBuf.append(pathString);
try {
//Bug 326957 - EFSExtensionProvider does not handle URI's correctly
//Bug 326957 - EFSExtensionProvider does not handle URI's correctly
return new URI(uri.getScheme(), uri.getAuthority(), pathBuf.toString(), // replaced!
uri.getQuery(), uri.getFragment());
} catch (URISyntaxException e) {
@ -111,15 +111,15 @@ public abstract class EFSExtensionProvider {
}
/**
* For filesystems that map the path to a physical file in one filesystem (say on a remote machine) to
* For file-systems that map the path to a physical file in one file-system (say on a remote machine) to
* another path (say, on the local machine), this method returns the path that the store maps to. I.e., it
* returns the path that the path returned by getPathFromURI(URI locationURI) maps to. If there is no such
* mapping, then an identity mapping of the paths is assumed.
*
* Typically if a filesystem maps one filesytem to another, it will place the mapped path in the path
*
* Typically if a file-system maps one file-system to another, it will place the mapped path in the path
* field of its URIs (which the default implementation assumes), but this is not guaranteed to be so for
* all filesystem implementations.
*
* all file-system implementations.
*
* @return String representing the path, or <code>null</code> on error.
*/
public String getMappedPath(URI locationURI) {
@ -127,9 +127,9 @@ public abstract class EFSExtensionProvider {
}
/**
* Returns true if the given URI is part of a virtual filesystem and thus points to another underlying
* URI. Returns false otherwise. By default, filesystems are assumed to be non-virtual.
*
* Returns true if the given URI is part of a virtual file-system and thus points to another underlying
* URI. Returns false otherwise. By default, file-systems are assumed to be non-virtual.
*
* @param locationURI
* @return boolean
*/
@ -139,12 +139,12 @@ public abstract class EFSExtensionProvider {
/**
* Creates a new URI with the same components as the baseURI, except that calling
* getPathFromURI() on the new URI will return a path that has the extension appended to
* getPathFromURI() on the new URI will return a path that has the extension appended to
* the path returned by baseURI.getPathFromURI()
*
*
* The default implementation assumes that the path component of the URI is used
* to store the path.
*
*
* @param baseURI
* @param extension
* @return the new URI, or <code>null</code> on error.