|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Content describers know how to retrieve metadata from contents.
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
ITextContentDescriber
instead.
Clients may implement this interface.
IContentDescription
Field Summary | |
---|---|
static int |
INDETERMINATE
Description result constant, indicating that it was not possible to determine whether the contents were valid for the intended content type. |
static int |
INVALID
Description result constant, indicating the contents are invalid for the intended content type. |
static int |
VALID
Description result constant, indicating the contents are valid for the intended content type. |
Method Summary | |
---|---|
int |
describe(InputStream contents,
IContentDescription description)
Tries to fill a description for the given contents. |
QualifiedName[] |
getSupportedOptions()
Returns the properties supported by this describer. |
Field Detail |
public static final int INDETERMINATE
describe(java.io.InputStream, org.eclipse.core.runtime.content.IContentDescription)
,
Constant Field Valuespublic static final int INVALID
describe(java.io.InputStream, org.eclipse.core.runtime.content.IContentDescription)
,
Constant Field Valuespublic static final int VALID
describe(java.io.InputStream, org.eclipse.core.runtime.content.IContentDescription)
,
Constant Field ValuesMethod Detail |
public int describe(InputStream contents, IContentDescription description) throws IOException
int
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.
contents
- the contents to be examineddescription
- a description to be filled in, or null
if
only content type validation is to be performed
VALID
INVALID
INDETERMINATE
IOException
- if an I/O error occursIContentDescription
,
VALID
,
INVALID
,
INDETERMINATE
public QualifiedName[] getSupportedOptions()
describe(java.io.InputStream, org.eclipse.core.runtime.content.IContentDescription)
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.