Eclipse Platform
Release 3.5

org.eclipse.core.resources
Interface IResourceFilterDescription


public interface IResourceFilterDescription

Interface for resource filters. A filter determines which file system objects will be visible when a local refresh is performed for an IContainer.

Since:
3.6
See Also:
IContainer.getFilters()
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

Field Summary
static int EXCLUDE_ALL
          Flag for resource filters indicating that the filter list excludes all the files matching the filters.
static int FILES
          Flag for resource filters indicating that this filter applies to files.
static int FOLDERS
          Flag for resource filters indicating that this filter applies to folders.
static int INCLUDE_ONLY
          Flag for resource filters indicating that the filter list includes only the files matching the filters.
static int INHERITABLE
          Flag for resource filters indicating that the container children of the path inherit from this filter as well.
 
Method Summary
 IFileInfoMatcherDescription getFileInfoMatcherDescription()
           
 IPath getPath()
          Return the project relative Path towards which this filter is set.
 IProject getProject()
          Returns the project which contains this filter.
 int getType()
          Return the filter type, either INCLUDE_ONLY or EXCLUDE_ALL
 void setFileInfoMatcherDescription(IFileInfoMatcherDescription description)
           
 void setType(int type)
           
 

Field Detail

INCLUDE_ONLY

static final int INCLUDE_ONLY
Flag for resource filters indicating that the filter list includes only the files matching the filters. All INCLUDE_ONLY filters are applied to the resource list with an logical OR operation.

See Also:
Constant Field Values

EXCLUDE_ALL

static final int EXCLUDE_ALL
Flag for resource filters indicating that the filter list excludes all the files matching the filters. All EXCLUDE_ALL filters are applied to the resource list with an logical AND operation.

See Also:
Constant Field Values

FILES

static final int FILES
Flag for resource filters indicating that this filter applies to files.

See Also:
Constant Field Values

FOLDERS

static final int FOLDERS
Flag for resource filters indicating that this filter applies to folders.

See Also:
Constant Field Values

INHERITABLE

static final int INHERITABLE
Flag for resource filters indicating that the container children of the path inherit from this filter as well.

See Also:
Constant Field Values
Method Detail

getPath

IPath getPath()
Return the project relative Path towards which this filter is set.

Returns:
the project relative Path towards which this filter is set

getProject

IProject getProject()
Returns the project which contains this filter.

This is a resource handle operation; neither the resource nor the resulting project need exist.

Returns:
the project handle

getType

int getType()
Return the filter type, either INCLUDE_ONLY or EXCLUDE_ALL

Returns:
(INCLUDE_ONLY or EXCLUDE_ALL) and/or INHERITABLE

setType

void setType(int type)

setFileInfoMatcherDescription

void setFileInfoMatcherDescription(IFileInfoMatcherDescription description)

getFileInfoMatcherDescription

IFileInfoMatcherDescription getFileInfoMatcherDescription()

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.