org.eclipse.tycho.repository.p2base.artifact.provider

Interface IRawArtifactProvider

All Superinterfaces:

IArtifactProvider, org.eclipse.equinox.p2.query.IQueryable<org.eclipse.equinox.p2.metadata.IArtifactKey>

All Known Subinterfaces:

IRawArtifactFileProvider

All Known Implementing Classes:

ProviderOnlyArtifactRepository

public interface IRawArtifactProvider
extends IArtifactProvider

Provider for artifact content in different formats.

Over IArtifactProvider, this interface adds methods for obtaining artifacts in raw formats, e.g. compressed with the JAR-optimized pack200 format. (With the IArtifactProvider interface, artifacts can only be obtained in the canonical format, i.e. the format in which the artifact can be used directly without additional decompression.)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor descriptor) Returns true if this a provider for an artifact in the given format
org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor[]	getArtifactDescriptors(org.eclipse.equinox.p2.metadata.IArtifactKey key) Return the raw artifact formats in which the given artifact can be provided
org.eclipse.core.runtime.IStatus	getRawArtifact(org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor descriptor, OutputStream destination, org.eclipse.core.runtime.IProgressMonitor monitor) Writes the artifact in the described raw format to the given output stream

Methods inherited from interface org.eclipse.tycho.repository.p2base.artifact.provider.IArtifactProvider

contains, getArtifact

Methods inherited from interface org.eclipse.equinox.p2.query.IQueryable

query

Method Detail

getArtifactDescriptors

org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor[] getArtifactDescriptors(org.eclipse.equinox.p2.metadata.IArtifactKey key)

Return the raw artifact formats in which the given artifact can be provided

Parameters:

key - the artifact key to lookup

Returns:

the descriptors associated with the given key

contains

boolean contains(org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor descriptor)

Returns true if this a provider for an artifact in the given format

Parameters:

descriptor - an artifact descriptor

Returns:

true if this instance can provide the artifact as raw artifact in the described format

getRawArtifact

org.eclipse.core.runtime.IStatus getRawArtifact(org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor descriptor,
                                              OutputStream destination,
                                              org.eclipse.core.runtime.IProgressMonitor monitor)

Writes the artifact in the described raw format to the given output stream

Parameters:

descriptor - the key and format of the artifact to transfer

destination - the stream to write the raw artifact to

monitor - a progress monitor, or null

Returns:

the result of the artifact transfer