public interface ISourceContainer extends IAdaptable
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
Modifier and Type | Method and Description |
---|---|
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)
Notification this source container has been added to the given
source lookup director.
|
boolean |
isComposite()
Returns whether this container is a composite container.
|
getAdapter
void init(ISourceLookupDirector director)
director
- the director this container has been added toObject[] 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 forCoreException
- if an exception occurs while searching for source elementsString getName()
ISourceContainer[] getSourceContainers() throws CoreException
CoreException
- if unable to retrieve source containersboolean isComposite()
ISourceContainerType getType()
void dispose()
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.