|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.team.core.RepositoryProviderType
This class represents provisional API. A provider is not required to implement this API. Implementers, and those who reference it, do so with the awareness that this class may be removed or substantially changed at future times without warning.
This class represents things you can ask/do with a type of provider. This is in the absence of a project, as opposed to RepositoryProvider which requires a concrete project in order to be instantiated.
A repository provider type class is associated with it's provider ID along with it's corresponding repository provider class. To add a repository provider type and have it registered with the platform, a client must minimally:
RepositoryProviderType
plugin.xml
.
Here is an example extension point definition:
<extension point="org.eclipse.team.core.repository">
<repository
class="org.eclipse.myprovider.MyRepositoryProvider"
typeClass="org.eclipse.myprovider.MyRepositoryProviderType"
id="org.eclipse.myprovider.myProviderID">
</repository>
</extension>
Once a repository provider type is registered with Team, then you
can access the singleton instance of the class by invoking RepositoryProviderType.getProviderType()
.
getProviderType(String)
Constructor Summary | |
---|---|
RepositoryProviderType()
|
Method Summary | |
---|---|
String |
getID()
Answer the id of this provider type. |
ProjectSetCapability |
getProjectSetCapability()
Answers an object for serializing and deserializing of references to projects. |
static RepositoryProviderType |
getProviderType(String id)
Return the RepositoryProviderType for the given provider ID. |
void |
metaFilesDetected(IProject project,
IContainer[] containers)
Callback from team when the meta-files for a repository type are detected in an unshared project. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RepositoryProviderType()
Method Detail |
public static RepositoryProviderType getProviderType(String id)
id
- the ID of the provider
getID()
public final String getID()
public ProjectSetCapability getProjectSetCapability()
Subclasses should override this method to return the appropriate serializer for the associated repository type. It is recommended that serializers not have any references to UI classes so that they can be used in a headless environment.
At this time, the default implementation wrappers the IProjectSetSerializer
interface if one exists, providing backward compatibility with existing code.
At some time in the future, the IProjectSetSerializer
interface will be removed
and the default implementation will revert to having limited functionality.
null
)public void metaFilesDetected(IProject project, IContainer[] containers)
repository
entry in the plugin manifest file.
By default, nothing is done (except that the repository type's plugin will have been loaded. Subclass may wish to mark the met-data as team-private. This method is called from a resource delta so subclasses may not obtain scheduling rules or in any way modify workspace resources (including auto-sharing the project). However, auto-sharing (or other modification) could be performed by a background job scheduled from this callback.
project
- the project that contains the detected meta-files.containers
- the folders (possibly including the project folder) in which meta-files were found
|
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.