Class XMLRootElementContentDescriber
- All Implemented Interfaces:
IContentDescriber
,ITextContentDescriber
,IExecutableExtension
This executable extension supports two parameters:
"dtd" and "element".
At least one of them must be provided. If the
":-"
method is used, then the value is treated as
"element".
This class is not intended to be subclassed or instantiated by clients,
only to be referenced by the "describer" configuration element in
extensions to the org.eclipse.core.runtime.contentTypes
extension point.
- Since:
- 3.0
- Restriction:
- This class is not intended to be instantiated by clients.
-
Field Summary
Fields inherited from interface org.eclipse.core.runtime.content.IContentDescriber
INDETERMINATE, INVALID, VALID
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
describe
(InputStream contents, IContentDescription description) Deprecated.Tries to fill a description for the given contents.int
describe
(InputStream contents, IContentDescription description, Map<String, Object> properties) Deprecated.int
describe
(Reader contents, IContentDescription description) Deprecated.Tries to fill a description for the given contents.int
Deprecated.void
setInitializationData
(IConfigurationElement config, String propertyName, Object data) Deprecated.This method is called by the implementation of the methodIConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration information.Methods inherited from class org.eclipse.core.runtime.content.XMLContentDescriber
getSupportedOptions
-
Constructor Details
-
XMLRootElementContentDescriber
public XMLRootElementContentDescriber()Deprecated.
-
-
Method Details
-
describe
Deprecated.Description copied from interface:IContentDescriber
Tries to fill a description for the given contents. Returns anint
indicating whether the given stream of bytes represents a valid sample for its corresponding content type. If no content description is provided, this method should perform content type validation.The input stream must be kept open, and any IOExceptions while reading the stream should flow to the caller.
- Specified by:
describe
in interfaceIContentDescriber
- Overrides:
describe
in classXMLContentDescriber
- Parameters:
contents
- the contents to be examineddescription
- a description to be filled in, ornull
if only content type validation is to be performed- Returns:
- one of the following:
VALID
INVALID
INDETERMINATE
- Throws:
IOException
- if an I/O error occurs- See Also:
-
describe
public int describe(InputStream contents, IContentDescription description, Map<String, Object> properties) throws IOExceptionDeprecated.- Throws:
IOException
- Restriction:
- This method is not intended to be referenced by clients.
-
describe
Deprecated.Description copied from interface:ITextContentDescriber
Tries to fill a description for the given contents. Returns anint
indicating whether the given stream of characters represents a valid sample for this describer's corresponding content type. If no content description is provided, this method should only perform content type validation.The stream provided must be kept open, and any IOExceptions while reading it should flow to the caller.
- Specified by:
describe
in interfaceITextContentDescriber
- Overrides:
describe
in classXMLContentDescriber
- Parameters:
contents
- the contents to be examineddescription
- a description to be filled in, ornull
if only content type validation is to be performed- Returns:
- one of the following:
VALID
INVALID
INDETERMINATE
- Throws:
IOException
- if an I/O error occurs- See Also:
-
describe
public int describe(Reader contents, IContentDescription description, Map<String, Object> properties) throws IOExceptionDeprecated.- Throws:
IOException
- Restriction:
- This method is not intended to be referenced by clients.
-
setInitializationData
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException Deprecated.Description copied from interface:IExecutableExtension
This method is called by the implementation of the methodIConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration information. Most executable extensions only make use of the first two call arguments.Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example
<action run="com.example.BaseAction"/>
In the above example, this method would be called with a reference to the
<action>
element (first argument), and"run"
as the name of the attribute that defined this executable extension (second argument).The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.
There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:
(1) by specifying adapter data as part of the implementation class attribute value. The Java class name can be followed by a ":" separator, followed by any adapter data in string form. For example, if the extension point specifies an attribute
"run"
to contain the name of the extension implementation, an adapter can be configured as<action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become
<action> <run class="com.xyz.ExternalAdapter"> <parameter name="exec" value="./cmds/util.exe"/> <parameter name="opt" value="3"/> </run> </action>
Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.
In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:
null
, if no adapter data was supplied- in case (1), the initialization data
string is passed as a
String
- in case (2), the initialization data is passed
as a
Hashtable
containing the actual parameter names and values (bothString
s)
- Specified by:
setInitializationData
in interfaceIExecutableExtension
- Parameters:
config
- the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration propertiespropertyName
- the name of an attribute of the configuration element used on thecreateExecutableExtension(String)
call. This argument can be used in the cases where a single configuration element is used to define multiple executable extensions.data
- adapter data in the form of aString
, aHashtable
, ornull
.- Throws:
CoreException
- if error(s) detected during initialization processing- See Also:
-
XMLRootElementContentDescriber2
instead