org.eclipse.sphinx.emf.scoping

Interface IResourceScopeProvider

All Known Implementing Classes:

AbstractResourceScopeProvider, FileResourceScopeProvider, ProjectResourceScopeProvider

public interface IResourceScopeProvider

A provider for resource scopes of workspace resources and model resources.

See Also:

IResourceScope

Method Summary

Modifier and Type	Method and Description
IResourceScope	getScope(org.eclipse.core.resources.IResource resource) Returns an resource scope for given workspace resource.
IResourceScope	getScope(org.eclipse.emf.ecore.resource.Resource resource) Returns an resource scope for given model resource.
boolean	hasApplicableFileExtension(org.eclipse.core.resources.IFile file) Tests if the given file's extension corresponds to a file type which is subject to resource scope provider.
boolean	isApplicableTo(org.eclipse.core.resources.IFile file) Tests if this resource scope provider is applicable to given file, i.e., if this resource scope provider is able or likely to be able to provide a resource scope for the given file.
org.eclipse.emf.common.util.Diagnostic	validate(org.eclipse.core.resources.IFile file) Validates given workspace file with regard to their resource scope and returns a diagnostic as validation result.

Method Detail

isApplicableTo

boolean isApplicableTo(org.eclipse.core.resources.IFile file)

Tests if this resource scope provider is applicable to given file, i.e., if this resource scope provider is able or likely to be able to provide a resource scope for the given file. This typically involves testing if a resource scope can be created for given file, exists, and is applicable to files having the extension of the given file.

This method is guaranteed to have a very little performance overhead.

Parameters:

file - The file to be investigated.

Returns:

true if this resource scope provider is applicable to given file, false otherwise.

See Also:

hasApplicableFileExtension(IFile)

hasApplicableFileExtension

boolean hasApplicableFileExtension(org.eclipse.core.resources.IFile file)

Tests if the given file's extension corresponds to a file type which is subject to resource scope provider.

This method is guaranteed to have a very little performance overhead.

Parameters:

file - The file to be investigated.

Returns:

true if this resource scope provider is applicable to files having the extension of the given file, false otherwise.

See Also:

isApplicableTo(IFile)

getScope

IResourceScope getScope(org.eclipse.core.resources.IResource resource)

Returns an resource scope for given workspace resource.

Parameters:

resource - The workspace resource to retrieve the resource scope for.

Returns:

The resource scope for given workspace resource.

getScope

IResourceScope getScope(org.eclipse.emf.ecore.resource.Resource resource)

Returns an resource scope for given model resource.

Parameters:

resource - The model resource to retrieve the resource scope for.

Returns:

The resource scope for given model resource.

validate

org.eclipse.emf.common.util.Diagnostic validate(org.eclipse.core.resources.IFile file)

Validates given workspace file with regard to their resource scope and returns a diagnostic as validation result.

Returns:

Diagnostic indicating resource scoping related problems, if any, or Diagnostic.OK_INSTANCE otherwise.