Package org.eclipse.core.runtime.content
Class XMLContentDescriber
java.lang.Object
org.eclipse.core.internal.content.TextContentDescriber
org.eclipse.core.runtime.content.XMLContentDescriber
- All Implemented Interfaces:
IContentDescriber,ITextContentDescriber
- Direct Known Subclasses:
XMLRootElementContentDescriber,XMLRootElementContentDescriber2
public class XMLContentDescriber
extends org.eclipse.core.internal.content.TextContentDescriber
A content describer for XML files. This class provides basis for XML-based
content describers.
The document is detected by the describer as VALID, if it
contains an xml declaration with <?xml prefix and the
encoding in the declaration is correct.
VALID
- <?xml version="1.0"?>
- <?xml version="1.0"
- <?xml version="1.0" encoding="utf-16"?>
- <?xml version="1.0" encoding="utf-16?>
- Since:
- org.eclipse.core.contenttype 3.4
- See Also:
- Restriction:
- This class is not intended to be instantiated by clients.
Clients should use it to provide their own XML-based
describers that can be referenced by the "describer"
configuration element in extensions to the
org.eclipse.core.runtime.contentTypesextension point.
-
Field Summary
Fields inherited from interface org.eclipse.core.runtime.content.IContentDescriber
INDETERMINATE, INVALID, VALID -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintdescribe(InputStream input, IContentDescription description) Tries to fill a description for the given contents.intdescribe(Reader input, IContentDescription description) Tries to fill a description for the given contents.Returns the properties supported by this describer.
-
Constructor Details
-
XMLContentDescriber
public XMLContentDescriber()
-
-
Method Details
-
describe
Description copied from interface:IContentDescriberTries to fill a description for the given contents. Returns anintindicating 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:
describein interfaceIContentDescriber- Overrides:
describein classorg.eclipse.core.internal.content.TextContentDescriber- Parameters:
input- the contents to be examineddescription- a description to be filled in, ornullif only content type validation is to be performed- Returns:
- one of the following:
VALIDINVALIDINDETERMINATE
- Throws:
IOException- if an I/O error occurs- See Also:
-
describe
Description copied from interface:ITextContentDescriberTries to fill a description for the given contents. Returns anintindicating 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:
describein interfaceITextContentDescriber- Overrides:
describein classorg.eclipse.core.internal.content.TextContentDescriber- Parameters:
input- the contents to be examineddescription- a description to be filled in, ornullif only content type validation is to be performed- Returns:
- one of the following:
VALIDINVALIDINDETERMINATE
- Throws:
IOException- if an I/O error occurs- See Also:
-
getSupportedOptions
Description copied from interface:IContentDescriberReturns the properties supported by this describer.- Specified by:
getSupportedOptionsin interfaceIContentDescriber- Overrides:
getSupportedOptionsin classorg.eclipse.core.internal.content.TextContentDescriber- Returns:
- the supported properties
- See Also:
-