Class ProcessingStepDescriptor
- java.lang.Object
-
- org.eclipse.equinox.p2.repository.artifact.spi.ProcessingStepDescriptor
-
- All Implemented Interfaces:
IProcessingStepDescriptor
public class ProcessingStepDescriptor extends Object implements IProcessingStepDescriptor
- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description ProcessingStepDescriptor(String processorId, String data, boolean required)Create a processing step description.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)StringgetData()An argument that is passed to the processing step instance.StringgetProcessorId()Returns the fully qualified id of the processing step extension.inthashCode()booleanisRequired()Returns whether the successful execution of this processing step is required for the transfer to be successful.StringtoString()Returns a string representation of this descriptor for debugging purposes only.
-
-
-
Constructor Detail
-
ProcessingStepDescriptor
public ProcessingStepDescriptor(String processorId, 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 String getProcessorId()
Description copied from interface:IProcessingStepDescriptorReturns the fully qualified id of the processing step extension.- Specified by:
getProcessorIdin interfaceIProcessingStepDescriptor- Returns:
- The fully qualified processing step extension id
-
getData
public String getData()
Description copied from interface:IProcessingStepDescriptorAn 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:
getDatain interfaceIProcessingStepDescriptor- Returns:
- the processing step data
-
isRequired
public boolean isRequired()
Description copied from interface:IProcessingStepDescriptorReturns 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:
isRequiredin interfaceIProcessingStepDescriptor- Returns:
trueif the transfer will fail if this step does not succeed, andfalseotherwise
-
-