|
Humboldt Alignment Editor 2.5.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOProvider
Interface for I/O providers
Field Summary | |
---|---|
static String |
PARAM_CONTENT_TYPE
The configuration parameter name for the content type |
Method Summary | |
---|---|
IOReporter |
createReporter()
Create a reporter configured for the execution of this I/O provider. |
IOReport |
execute(ProgressIndicator progress)
Execute the I/O provider. |
org.eclipse.core.runtime.content.IContentType |
getContentType()
Get the content type |
String |
getParameter(String name)
Get the value for the given parameter name |
Set<String> |
getSupportedParameters()
Get the supported configuration parameters. |
boolean |
isCancelable()
States if the execution of the provider is cancelable |
void |
loadConfiguration(Map<String,String> configuration)
Load the configuration from a map of key/value pairs |
void |
setContentType(org.eclipse.core.runtime.content.IContentType contentType)
Set the content type. |
void |
setParameter(String name,
String value)
Set a parameter |
void |
storeConfiguration(Map<String,String> configuration)
Store the configuration in a map of key/value pairs |
void |
validate()
Validate the I/O provider configuration |
Field Detail |
---|
static final String PARAM_CONTENT_TYPE
Method Detail |
---|
IOReport execute(ProgressIndicator progress) throws IOProviderConfigurationException, IOException
progress
- the progress indicator, may be null
IOProviderConfigurationException
- if the I/O provider was not
configured properly
IOException
- if an I/O operation failsIOReporter createReporter()
execute(ProgressIndicator)
.
boolean isCancelable()
void validate() throws IOProviderConfigurationException
IOProviderConfigurationException
- if the I/O provider was not
configured properlyvoid setContentType(org.eclipse.core.runtime.content.IContentType contentType)
contentType
- the content typeorg.eclipse.core.runtime.content.IContentType getContentType()
null
Set<String> getSupportedParameters()
void setParameter(String name, String value)
name
- the parameter namevalue
- the parameter valueString getParameter(String name)
name
- the parameter name
null
void loadConfiguration(Map<String,String> configuration)
configuration
- the configuration to loadvoid storeConfiguration(Map<String,String> configuration)
configuration
- the configuration to populate
|
Humboldt Alignment Editor 2.5.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |