|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A source container is a container of source code. A source container is capable of searching for source elements by name. For example, a source container may be a project or a directory capable of searching for files by name. A source container may be a composite container - i.e. contain other source containers.
When a source container is created and added to a source director, the
source container's dispose()
method is called when the
source director is disposed. Clients creating source containers for other
purposes must dispose of containers themselves.
Clients may implement this interface.
ISourceLookupParticipant
,
ISourceContainerType
Method Summary | |
---|---|
void |
dispose()
Disposes this source container. |
Object[] |
findSourceElements(String name)
Returns a collection of source elements in this container corresponding to the given name. |
String |
getName()
The name of this source container that can be used for presentation purposes. |
ISourceContainer[] |
getSourceContainers()
Returns the source containers this container is composed of. |
ISourceContainerType |
getType()
Returns this container's type. |
void |
init(ISourceLookupDirector director)
Notifiation this source container has been added to the given source lookup director. |
boolean |
isComposite()
Returns whether this container is a composite container. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Method Detail |
public void init(ISourceLookupDirector director)
director
- the director this container has been added topublic Object[] findSourceElements(String name) throws CoreException
isFindDuplicates()
.
When false
the returned collection should contain at most one
source element. If this is a composite container, the containers contained
by this container are also searched.
The format of the given name is implementation specific but generally conforms to the format of a file name. If a source container does not recognize the name format provided, an empty collection should be returned. A source container may or may not require names to be fully qualified (i.e. be qualified with directory names).
name
- the name of the source element to search for
CoreException
- if an exception occurrs while searching for source elementspublic String getName()
public ISourceContainer[] getSourceContainers() throws CoreException
CoreException
- if unable to retrieve source containerspublic boolean isComposite()
public ISourceContainerType getType()
public void dispose()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.