public interface IContentDescriber
Note: It is expected that content describer implementations be declared in a package that is exempt from plug-in activation (using the Eclipse-AutoStart bundle manifest header). Since all describers are instantiated when the content type framework is initialized, failure in complying with this requirement causes premature activation, which must be avoided. Future implementations of the framework might refuse to instantiate describers if doing so would trigger activation of the corresponding plug-in.
Describers for text-based content types should implement
Clients may implement this interface.
|Modifier and Type||Field and Description|
Description result constant, indicating that it was not possible to determine whether the contents were valid for the intended content type.
Description result constant, indicating the contents are invalid for the intended content type.
Description result constant, indicating the contents are valid for the intended content type.
static final int INDETERMINATE
static final int INVALID
static final int VALID
int describe(InputStream contents, IContentDescription description) throws IOException
intindicating 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.
contents- the contents to be examined
description- a description to be filled in, or
nullif only content type validation is to be performed
IOException- if an I/O error occurs
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.