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

Class ProcessingStepDescriptor

java.lang.Object

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

All Implemented Interfaces:

IProcessingStepDescriptor

public class ProcessingStepDescriptor
extends java.lang.Object
implements IProcessingStepDescriptor

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
ProcessingStepDescriptor(java.lang.String processorId, java.lang.String data, boolean required)	Create a processing step description.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getData()	An argument that is passed to the processing step instance.
java.lang.String	getProcessorId()	Returns the fully qualified id of the processing step extension.
int	hashCode()
boolean	isRequired()	Returns whether the successful execution of this processing step is required for the transfer to be successful.
java.lang.String	toString()	Returns a string representation of this descriptor for debugging purposes only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessingStepDescriptor

public ProcessingStepDescriptor(java.lang.String processorId,
                                java.lang.String data,
                                boolean required)

Create a processing step description.

Parameters:

processorId - The fully qualified processing step extension id.

data - The processing step data. The structure and content of the data is specific to the particular processing step being used.

required - Whether the successful execution of this processing step is required for the transfer to be successful.

Method Detail

getProcessorId

public java.lang.String getProcessorId()

Description copied from interface: IProcessingStepDescriptor

Returns the fully qualified id of the processing step extension.

Specified by:

getProcessorId in interface IProcessingStepDescriptor

Returns:

The fully qualified processing step extension id

getData

public java.lang.String getData()

Description copied from interface: IProcessingStepDescriptor

An argument that is passed to the processing step instance. The structure and content of the data is specific to the particular processing step being used.

Specified by:

getData in interface IProcessingStepDescriptor

Returns:

the processing step data

isRequired

public boolean isRequired()

Description copied from interface: IProcessingStepDescriptor

Returns whether the successful execution of this processing step is required for the transfer to be successful. If the processing step extension is not installed, or fails to execute, then the artifact transfer will fail if the step is required. Failure of optional steps will result in warnings but not prevent the transfer from succeeding.

Specified by:

isRequired in interface IProcessingStepDescriptor

Returns:

true if the transfer will fail if this step does not succeed, and false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of this descriptor for debugging purposes only.

Overrides:

toString in class java.lang.Object

Returns:

a string representation ofthe processing step descriptor