Eclipse Platform
Release 3.6

org.eclipse.equinox.p2.repository.metadata
Interface IMetadataRepository

All Superinterfaces:
IAdaptable, IQueryable<IInstallableUnit>, IRepository<IInstallableUnit>
All Known Implementing Classes:
AbstractMetadataRepository

public interface IMetadataRepository
extends IRepository<IInstallableUnit>

A metadata repository stores information about a set of installable units

This interface is not intended to be implemented by clients. Metadata repository implementations must subclass AbstractMetadataRepository rather than implementing this interface directly.

Since:
2.0
Restriction:
This interface is not intended to be implemented by clients.

Field Summary
 
Fields inherited from interface org.eclipse.equinox.p2.repository.IRepository
ENABLED, NONE, PREFERENCE_NODE, PROP_COMPRESSED, PROP_DESCRIPTION, PROP_MIRRORS_BASE_URL, PROP_MIRRORS_URL, PROP_NAME, PROP_NICKNAME, PROP_PASSWORD, PROP_SYSTEM, PROP_TIMESTAMP, PROP_USERNAME, TYPE_ARTIFACT, TYPE_METADATA
 
Method Summary
 void addInstallableUnits(Collection<IInstallableUnit> installableUnits)
          Add the given installable units to this repository.
 void addInstallableUnits(IInstallableUnit[] installableUnits)
          Deprecated. use addInstallableUnits(Collection)
 void addReference(URI location, String nickname, int type, int options)
          Adds a reference to another repository to this repository.
 void removeAll()
          Remove all installable units from this repository.
 boolean removeInstallableUnits(Collection<IInstallableUnit> installableUnits)
          Removes all installable units in the given collection from this repository.
 boolean removeInstallableUnits(IInstallableUnit[] installableUnits, IProgressMonitor monitor)
          Deprecated. use removeInstallableUnits(Collection)
 
Methods inherited from interface org.eclipse.equinox.p2.repository.IRepository
getDescription, getLocation, getName, getProperties, getProvider, getProvisioningAgent, getType, getVersion, isModifiable, setDescription, setName, setProperty, setProvider
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.equinox.p2.query.IQueryable
query
 

Method Detail

addInstallableUnits

void addInstallableUnits(IInstallableUnit[] installableUnits)
Deprecated. use addInstallableUnits(Collection)


addInstallableUnits

void addInstallableUnits(Collection<IInstallableUnit> installableUnits)
Add the given installable units to this repository.

Parameters:
installableUnits - the installable units to add

addReference

void addReference(URI location,
                  String nickname,
                  int type,
                  int options)
Adds a reference to another repository to this repository. When a repository is loaded by IMetadataRepositoryManager, its references are automatically added to the repository manager's set of known repositories.

Note that this method does not add the contents of the given repository to this repository, but merely adds the location of another repository to the metadata of this repository.

The IRepository.ENABLED option flag controls whether the referenced repository should be marked as enabled when added to the repository manager. If this flag is set, the repository will be marked as enabled when added to the repository manager. If this flag is missing, the repository will be marked as disabled.

Parameters:
location - the location of the repository to add
nickname - The nickname of the repository, or null
type - the repository type (currently either IRepository.TYPE_METADATA or IRepository.TYPE_ARTIFACT).
options - bit-wise or of option constants (currently either IRepository.ENABLED or IRepository.NONE).
See Also:
IRepositoryManager.setEnabled(URI, boolean)

removeInstallableUnits

boolean removeInstallableUnits(IInstallableUnit[] installableUnits,
                               IProgressMonitor monitor)
Deprecated. use removeInstallableUnits(Collection)


removeInstallableUnits

boolean removeInstallableUnits(Collection<IInstallableUnit> installableUnits)
Removes all installable units in the given collection from this repository.

Parameters:
installableUnits - the installable units to remove
Returns:
true if any units were actually removed, and false otherwise

removeAll

void removeAll()
Remove all installable units from this repository.


Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

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