public interface IOProvider
Modifier and Type | Field and Description |
---|---|
static String |
PARAM_CHARSET
The configuration parameter name for the character set
|
static String |
PARAM_CONTENT_TYPE
The configuration parameter name for the content type
|
Modifier and Type | Method and Description |
---|---|
IOReporter |
createReporter()
Create a reporter configured for the execution of this I/O provider.
|
IOReport |
execute(ProgressIndicator progress)
Execute the I/O provider.
|
Charset |
getCharset()
Get the configured character set.
|
org.eclipse.core.runtime.content.IContentType |
getContentType()
Get the content type
|
Value |
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,Value> configuration)
Load the configuration from a map of key/value pairs
|
void |
setCharset(Charset charset)
Set the character set that should be used for encoding/decoding.
|
void |
setContentType(org.eclipse.core.runtime.content.IContentType contentType)
Set the content type.
|
void |
setParameter(String name,
Value value)
Set a parameter
|
void |
storeConfiguration(Map<String,Value> configuration)
Store the configuration in a map of key/value pairs
|
void |
validate()
Validate the I/O provider configuration
|
static final String PARAM_CONTENT_TYPE
static final String PARAM_CHARSET
IOReport execute(ProgressIndicator progress) throws IOProviderConfigurationException, IOException
progress
- the progress indicator, may be null
IOProviderConfigurationException
- if the I/O provider was not
configured properlyIOException
- 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
void setCharset(Charset charset)
charset
- the character setCharset getCharset()
null
Set<String> getSupportedParameters()
void setParameter(String name, Value value)
name
- the parameter namevalue
- the parameter value, it is either a string, a DOM elements
or a complex value types defined in the
ComplexValueExtension
Value getParameter(String name)
name
- the parameter namenull
, the value is either a
string, a DOM elements or a complex value types defined in the
ComplexValueExtension
void loadConfiguration(Map<String,Value> configuration)
configuration
- the configuration to load, values are either
strings, DOM elements or complex value types defined in the
ComplexValueExtension
void storeConfiguration(Map<String,Value> configuration)
configuration
- the configuration to populate, values are either
strings, DOM elements or complex value types defined in the
ComplexValueExtension
Build 2013-10-07_11-27-38
Revision 99b27713a799a59a21b0b166eaaea8aaefbf125a