|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.equinox.p2.repository.metadata.spi.MetadataRepositoryFactory
public abstract class MetadataRepositoryFactory
A metadata repository factory is responsible for creating and loading instances of a particular type of metadata repository. Factories are provided via the org.eclipse.equinox.p2.metadata.repository.metadataRepositories extension point.
Constructor Summary | |
---|---|
MetadataRepositoryFactory()
|
Method Summary | |
---|---|
abstract IMetadataRepository |
create(URI location,
String name,
String type,
Map<String,String> properties)
Creates and returns a new empty metadata repository of the given type at the given location. |
protected IProvisioningAgent |
getAgent()
Returns the provisioning agent associated with this factory, or null
if this factory is not associated with an agent. |
abstract IMetadataRepository |
load(URI location,
int flags,
IProgressMonitor monitor)
Loads a repository corresponding to the given URL. |
void |
setAgent(IProvisioningAgent agent)
Sets the provisioning agent associated with this repository factory. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MetadataRepositoryFactory()
Method Detail |
---|
public abstract IMetadataRepository create(URI location, String name, String type, Map<String,String> properties) throws ProvisionException
location
- the location for the new repositoryname
- the name of the new repositorytype
- the kind of repository to createproperties
- the properties to set on the repository
ProvisionException
- if the repository could not be created. Reasons include:
protected IProvisioningAgent getAgent()
null
if this factory is not associated with an agent.
null
public abstract IMetadataRepository load(URI location, int flags, IProgressMonitor monitor) throws ProvisionException
The error code returned in the case of failure is significant. In particular an
error code of ProvisionException.REPOSITORY_FAILED_READ
indicates
that the location definitely identifies a repository of this type, but an error occurred
while loading the repository. The repository manager will not attempt to load
a repository from that location using any other factory. An error code of
ProvisionException.REPOSITORY_NOT_FOUND
indicates there is no
repository of this type at the given location, and the repository manager is free
to try again with a different repository factory.
The flags passed in should be taken as a hint for the type of repository to load. If
the factory knows it will not load a repository that satisfies these hints, it can fail
fast and return null.
See IRepositoryManager.REPOSITORY_HINT_MODIFIABLE
location
- The location of the repository to loadflags
- to consider while loading the repositorymonitor
- a progress monitor, or null
if progress
reporting is not desired
ProvisionException
- if the repository could not be created. Reasons include:
public void setAgent(IProvisioningAgent agent)
agent
- The provisioning agent
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.