Class AbstractRepository<T>
java.lang.Object
org.eclipse.core.runtime.PlatformObject
org.eclipse.equinox.p2.repository.spi.AbstractRepository<T>
- Type Parameters:
T- the type of object that can be queried for in this repository
- All Implemented Interfaces:
IAdaptable,IQueryable<T>,IRepository<T>
- Direct Known Subclasses:
AbstractArtifactRepository,AbstractMetadataRepository
AbstractRepository defines common properties that may be provided by various kinds
of repositories.
Clients may extend this class.
- Since:
- 2.0
-
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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidAsserts that this repository is modifiable, throwing a runtime exception if it is not.Returns a brief description of the repository.Returns the location of this repository.getName()Returns the name of the repository.Returns a read-only collection of the properties of the repository.getProperty(String key) Returns the repository property with the given key, ornullif no such property is definedReturns the name of the provider of the repository.Returns the provisioning agent used by this repositorygetType()Returns a string representing the type of the repository.Returns a string representing the version for the repository type.booleanReturnstrueif this repository can be modified, andfalseotherwise.voidsetDescription(String description) Sets the description of this repositoryprotected voidsetLocation(URI location) Sets the location of this repositoryvoidSets the name of this repositoryprotected voidsetProperties(Map<String, String> properties) Sets the properties of this repositorysetProperty(String key, String value) Sets the value of the property with the given key.setProperty(String key, String value, IProgressMonitor monitor) Sets the value of the property with the given key.voidsetProvider(String provider) Sets the provider of this repositoryprotected voidSets the type of this repositoryprotected voidsetVersion(String version) Sets the version of this repositorytoString()Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapterMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapterMethods inherited from interface org.eclipse.equinox.p2.query.IQueryable
queryMethods inherited from interface org.eclipse.equinox.p2.repository.IRepository
contains
-
Constructor Details
-
AbstractRepository
protected AbstractRepository(IProvisioningAgent agent, String name, String type, String version, URI location, String description, String provider, Map<String, String> properties) Creates a new repository with the given attributes.- Parameters:
agent- the provisioning agent to be used by this repositoryname- the repository nametype- the repository typeversion- the repository versionlocation- the repository locationdescription- the repository descriptionprovider- the repository providerproperties- the repository properties
-
-
Method Details
-
assertModifiable
protected void assertModifiable()Asserts that this repository is modifiable, throwing a runtime exception if it is not. This is suitable for use by subclasses when an attempt is made to write to a repository. -
getDescription
Returns a brief description of the repository.- Specified by:
getDescriptionin interfaceIRepository<T>- Returns:
- the description of the repository.
-
getLocation
Returns the location of this repository.- Specified by:
getLocationin interfaceIRepository<T>- Returns:
- the URI of the repository.
-
getName
Returns the name of the repository.- Specified by:
getNamein interfaceIRepository<T>- Returns:
- the name of the repository.
-
getProperties
Returns a read-only collection of the properties of the repository.- Specified by:
getPropertiesin interfaceIRepository<T>- Returns:
- the properties of this repository.
-
getProperty
Description copied from interface:IRepositoryReturns the repository property with the given key, ornullif no such property is defined- Specified by:
getPropertyin interfaceIRepository<T>- Parameters:
key- the property key- Returns:
- the property value, or
null
-
getProvider
Returns the name of the provider of the repository.- Specified by:
getProviderin interfaceIRepository<T>- Returns:
- the provider of this repository.
-
getProvisioningAgent
Returns the provisioning agent used by this repository- Specified by:
getProvisioningAgentin interfaceIRepository<T>- Returns:
- the provisioning agent
-
getType
Returns a string representing the type of the repository.- Specified by:
getTypein interfaceIRepository<T>- Returns:
- the type of the repository.
-
getVersion
Returns a string representing the version for the repository type.- Specified by:
getVersionin interfaceIRepository<T>- Returns:
- the version of the type of the repository.
-
isModifiable
public boolean isModifiable()Description copied from interface:IRepositoryReturnstrueif this repository can be modified, andfalseotherwise. Attempts to change the contents of an unmodifiable repository will fail.- Specified by:
isModifiablein interfaceIRepository<T>- Returns:
- whether or not this repository can be modified
-
setDescription
Sets the description of this repository- Parameters:
description- the repository description
-
setName
Sets the name of this repository- Parameters:
value- the repository name
-
setProperty
Description copied from interface:IRepositorySets the value of the property with the given key. Returns the old property associated with that key, if any. Setting a value ofnullwill remove the corresponding key from the properties of this repository.- Specified by:
setPropertyin interfaceIRepository<T>- Parameters:
key- The property keyvalue- The new property value, ornullto remove the keymonitor- A progress monitor use to track progress and cancel the operation. This may be a long running operation if another process holds the lock on this location- Returns:
- The old property value, or
nullif there was no old value - Since:
- 2.1
-
setProperty
Description copied from interface:IRepositorySets the value of the property with the given key. Returns the old property associated with that key, if any. Setting a value ofnullwill remove the corresponding key from the properties of this repository.- Specified by:
setPropertyin interfaceIRepository<T>- Parameters:
key- The property keyvalue- The new property value, ornullto remove the key- Returns:
- The old property value, or
nullif there was no old value
-
setProvider
Sets the provider of this repository- Parameters:
provider- the repository provider
-
setType
Sets the type of this repository- Parameters:
type- the repository type
-
setLocation
Sets the location of this repository- Parameters:
location- the repository location
-
setVersion
Sets the version of this repository- Parameters:
version- the repository version
-
setProperties
Sets the properties of this repository- Parameters:
properties- the repository provider
-
toString
-