Class ArtifactDescriptor
- java.lang.Object
-
- org.eclipse.equinox.p2.repository.artifact.spi.ArtifactDescriptor
-
- All Implemented Interfaces:
IMemberProvider
,IArtifactDescriptor
public class ArtifactDescriptor extends 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 Description protected IArtifactKey
key
static String
MEMBER_ARTIFACT_KEY
static String
MEMBER_PROCESSING_STEPS
static String
MEMBER_PROPERTIES
static String
MEMBER_REPOSITORY
protected IProcessingStepDescriptor[]
processingSteps
protected Map<String,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 Description ArtifactDescriptor(IArtifactKey key)
Returns a new artifact descriptor that uses the provided artifact keyArtifactDescriptor(IArtifactDescriptor base)
Creates a new artifact descriptor with the same key, properties, repository, and processing steps as the provided base descriptor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addProperties(Map<String,String> additionalProperties)
boolean
equals(Object obj)
IArtifactKey
getArtifactKey()
Return the key for the artifact described by this descriptor.Object
getMember(String memberName)
Returns the value for the specified member.IProcessingStepDescriptor[]
getProcessingSteps()
Return the list of processing steps associated with this descriptor.Map<String,String>
getProperties()
Returns a read-only collection of the properties of the artifact descriptor.String
getProperty(String propertyKey)
Return the value of the given property in this descriptornull
is returned if no such property existsIArtifactRepository
getRepository()
Return the artifact repository that holds the artifact described by this descriptor.int
hashCode()
void
setProcessingSteps(IProcessingStepDescriptor[] value)
void
setProperty(String key, String value)
void
setRepository(IArtifactRepository value)
String
toString()
-
-
-
Field Detail
-
MEMBER_ARTIFACT_KEY
public static final String MEMBER_ARTIFACT_KEY
- See Also:
- Constant Field Values
-
MEMBER_PROCESSING_STEPS
public static final String MEMBER_PROCESSING_STEPS
- See Also:
- Constant Field Values
-
MEMBER_PROPERTIES
public static final String MEMBER_PROPERTIES
- See Also:
- Constant Field Values
-
MEMBER_REPOSITORY
public static final String MEMBER_REPOSITORY
- See Also:
- Constant Field Values
-
key
protected IArtifactKey key
-
processingSteps
protected IProcessingStepDescriptor[] processingSteps
-
-
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 interfaceIArtifactDescriptor
- Returns:
- the key associated with this descriptor
-
getProperty
public String getProperty(String propertyKey)
Description copied from interface:IArtifactDescriptor
Return the value of the given property in this descriptornull
is returned if no such property exists- Specified by:
getProperty
in interfaceIArtifactDescriptor
- Parameters:
propertyKey
- the property key to look for- Returns:
- the value of the given property or
null
-
getProperties
public Map<String,String> getProperties()
Returns a read-only collection of the properties of the artifact descriptor.- Specified by:
getProperties
in interfaceIArtifactDescriptor
- 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 interfaceIArtifactDescriptor
- Returns:
- the list of processing steps for this descriptor
-
setProcessingSteps
public void setProcessingSteps(IProcessingStepDescriptor[] value)
-
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 interfaceIArtifactDescriptor
- Returns:
- the repository holding this artifact or
null
if none.
-
setRepository
public void setRepository(IArtifactRepository value)
-
getMember
public Object getMember(String memberName)
Description copied from interface:IMemberProvider
Returns the value for the specified member. Implementers can rely on that thememberName
is a string that has been internalized usingString.intern()
.- Specified by:
getMember
in interfaceIMemberProvider
- Parameters:
memberName
- The name of the member- Returns:
- The member value.
-
-