|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Text content describers extend basic content describers to provide
the ability of scanning character streams (readers). Describers for
text-based content types must implement this interface
instead of IContentDescription
.
Clients may implement this interface.
IContentDescription
Field Summary |
Fields inherited from interface org.eclipse.core.runtime.content.IContentDescriber |
INDETERMINATE, INVALID, VALID |
Method Summary | |
int |
describe(Reader contents,
IContentDescription description)
Tries to fill a description for the given contents. |
Methods inherited from interface org.eclipse.core.runtime.content.IContentDescriber |
describe, getSupportedOptions |
Method Detail |
public int describe(Reader contents, IContentDescription description) throws IOException
int
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.
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
,
IContentDescriber.VALID
,
IContentDescriber.INVALID
,
IContentDescriber.INDETERMINATE
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.