org.eclipse.equinox.p2.repository.artifact.spi

Class ArtifactDescriptor

java.lang.Object

org.eclipse.equinox.p2.repository.artifact.spi.ArtifactDescriptor

All Implemented Interfaces:

IMemberProvider, IArtifactDescriptor

public class ArtifactDescriptor
extends java.lang.Object
implements IArtifactDescriptor, IMemberProvider

This represents information about a given artifact stored on a particular byte server.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected IArtifactKey	key
static java.lang.String	MEMBER_ARTIFACT_KEY
static java.lang.String	MEMBER_PROCESSING_STEPS
static java.lang.String	MEMBER_PROPERTIES
static java.lang.String	MEMBER_REPOSITORY
protected IProcessingStepDescriptor[]	processingSteps
protected java.util.Map<java.lang.String,java.lang.String>	properties

Fields inherited from interface org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor

ARTIFACT_CHECKSUM, ARTIFACT_MD5, ARTIFACT_SIZE, DOWNLOAD_CHECKSUM, DOWNLOAD_CONTENTTYPE, DOWNLOAD_MD5, DOWNLOAD_SIZE, FORMAT, FORMAT_PACKED, TYPE_ZIP

Constructor Summary

Constructors

Constructor and Description
ArtifactDescriptor(IArtifactDescriptor base) Creates a new artifact descriptor with the same key, properties, repository, and processing steps as the provided base descriptor.
ArtifactDescriptor(IArtifactKey key) Returns a new artifact descriptor that uses the provided artifact key

Method Summary

Modifier and Type	Method and Description
void	addProperties(java.util.Map<java.lang.String,java.lang.String> additionalProperties)
boolean	equals(java.lang.Object obj)
IArtifactKey	getArtifactKey() Return the key for the artifact described by this descriptor.
java.lang.Object	getMember(java.lang.String memberName) Returns the value for the specified member.
IProcessingStepDescriptor[]	getProcessingSteps() Return the list of processing steps associated with this descriptor.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns a read-only collection of the properties of the artifact descriptor.
java.lang.String	getProperty(java.lang.String propertyKey) Return the value of the given property in this descriptor null is returned if no such property exists
IArtifactRepository	getRepository() Return the artifact repository that holds the artifact described by this descriptor.
int	hashCode()
void	setProcessingSteps(IProcessingStepDescriptor[] value)
void	setProperty(java.lang.String key, java.lang.String value)
void	setRepository(IArtifactRepository value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MEMBER_ARTIFACT_KEY

public static final java.lang.String MEMBER_ARTIFACT_KEY

See Also:

Constant Field Values

MEMBER_PROCESSING_STEPS

public static final java.lang.String MEMBER_PROCESSING_STEPS

See Also:

Constant Field Values

MEMBER_PROPERTIES

public static final java.lang.String MEMBER_PROPERTIES

See Also:

Constant Field Values

MEMBER_REPOSITORY

public static final java.lang.String MEMBER_REPOSITORY

See Also:

Constant Field Values

key

protected IArtifactKey key

processingSteps

protected IProcessingStepDescriptor[] processingSteps

properties

protected java.util.Map<java.lang.String,java.lang.String> properties

Constructor Detail

ArtifactDescriptor

public ArtifactDescriptor(IArtifactDescriptor base)

Creates a new artifact descriptor with the same key, properties, repository, and processing steps as the provided base descriptor.

Parameters:

base - the descriptor to use as a template for this new descriptor

ArtifactDescriptor

public ArtifactDescriptor(IArtifactKey key)

Returns a new artifact descriptor that uses the provided artifact key

Parameters:

key - The artifact key corresponding to this descriptor

Method Detail

getArtifactKey

public IArtifactKey getArtifactKey()

Description copied from interface: IArtifactDescriptor

Return the key for the artifact described by this descriptor.

Specified by:

getArtifactKey in interface IArtifactDescriptor

Returns:

the key associated with this descriptor

getProperty

public java.lang.String getProperty(java.lang.String propertyKey)

Description copied from interface: IArtifactDescriptor

Return the value of the given property in this descriptor null is returned if no such property exists

Specified by:

getProperty in interface IArtifactDescriptor

Parameters:

propertyKey - the property key to look for

Returns:

the value of the given property or null

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

addProperties

public void addProperties(java.util.Map<java.lang.String,java.lang.String> additionalProperties)

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns a read-only collection of the properties of the artifact descriptor.

Specified by:

getProperties in interface IArtifactDescriptor

Returns:

the properties of this artifact descriptor.

getProcessingSteps

public IProcessingStepDescriptor[] getProcessingSteps()

Description copied from interface: IArtifactDescriptor

Return the list of processing steps associated with this descriptor. An empty set of steps implies that this descriptor describes a complete copy of the artifact in its native form. If one or more steps are present, they may be performed when the artifact is transferred from the repository that contains it.

Specified by:

getProcessingSteps in interface IArtifactDescriptor

Returns:

the list of processing steps for this descriptor

setProcessingSteps

public void setProcessingSteps(IProcessingStepDescriptor[] value)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRepository

public IArtifactRepository getRepository()

Description copied from interface: IArtifactDescriptor

Return the artifact repository that holds the artifact described by this descriptor. null is returned if this descriptor is not held in a repository.

Specified by:

getRepository in interface IArtifactDescriptor

Returns:

the repository holding this artifact or null if none.

setRepository

public void setRepository(IArtifactRepository value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMember

public java.lang.Object getMember(java.lang.String memberName)

Description copied from interface: IMemberProvider

Returns the value for the specified member. Implementers can rely on that the memberName is a string that has been internalized using String.intern().

Specified by:

getMember in interface IMemberProvider

Parameters:

memberName - The name of the member

Returns:

The member value.