Class ProcessingStepDescriptor
java.lang.Object
org.eclipse.equinox.p2.repository.artifact.spi.ProcessingStepDescriptor
- All Implemented Interfaces:
IProcessingStepDescriptor
- Since:
- 2.0
-
Constructor Summary
ConstructorsConstructorDescriptionProcessingStepDescriptor
(String processorId, String data, boolean required) Create a processing step description. -
Method Summary
Modifier and TypeMethodDescriptionboolean
getData()
An argument that is passed to the processing step instance.Returns the fully qualified id of the processing step extension.int
hashCode()
boolean
Returns whether the successful execution of this processing step is required for the transfer to be successful.toString()
Returns a string representation of this descriptor for debugging purposes only.
-
Constructor Details
-
ProcessingStepDescriptor
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 Details
-
getProcessorId
Description copied from interface:IProcessingStepDescriptor
Returns the fully qualified id of the processing step extension.- Specified by:
getProcessorId
in interfaceIProcessingStepDescriptor
- Returns:
- The fully qualified processing step extension id
-
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 interfaceIProcessingStepDescriptor
- 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 interfaceIProcessingStepDescriptor
- Returns:
true
if the transfer will fail if this step does not succeed, andfalse
otherwise
-
hashCode
public int hashCode() -
equals
-
toString
Returns a string representation of this descriptor for debugging purposes only.
-