|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The content type manager provides facilities file name and content-based type lookup, and content description.
This interface is not intended to be implemented by clients.
Platform.getContentTypeManager()
Nested Class Summary | |
static class |
IContentTypeManager.ContentTypeChangeEvent
An event object which describes the details of a change to a content type. |
static interface |
IContentTypeManager.IContentTypeChangeListener
A listener to be used to receive content type change events. |
Field Summary | |
static String |
CT_TEXT
Content type identifier constant for platform's primary text-based content type: org.eclipse.core.runtime.text .
|
Method Summary | |
void |
addContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener listener)
Register the given listener for notification of content type changes. |
IContentType |
findContentTypeFor(InputStream contents,
String fileName)
Returns the preferred content type for the given contents and file name. |
IContentType |
findContentTypeFor(String fileName)
Returns the preferred content type for the given file name. |
IContentType[] |
findContentTypesFor(InputStream contents,
String fileName)
Returns the content types associated to the given contents and file name. |
IContentType[] |
findContentTypesFor(String fileName)
Returns all content types known by the platform that are associated to the given file name. |
IContentType[] |
getAllContentTypes()
Returns all content types known by the platform. |
IContentType |
getContentType(String contentTypeIdentifier)
Returns the content type with the given identifier, or null
if no such content type is known by the platform. |
IContentDescription |
getDescriptionFor(InputStream contents,
String fileName,
QualifiedName[] options)
Tries to obtain a description for the given contents and file name. |
IContentDescription |
getDescriptionFor(Reader contents,
String fileName,
QualifiedName[] options)
Tries to obtain a description for the given contents and file name. |
void |
removeContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener listener)
De-register the given listener from receiving notification of content type changes. |
Field Detail |
public static final String CT_TEXT
org.eclipse.core.runtime.text
.
All text-based content types ought to be sub types of the content type identified by this string. This provides a simple way for detecting whether a content type is text-based:
IContentType text = Platform.getContentTypeManager().getContentType(IContentTypeManager.CT_TEXT); IContentType someType = ...; boolean isTextBased = someType.isKindOf(text);
Method Detail |
public void addContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener listener)
null
.
listener
- the content type change listener to registerremoveContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener)
,
IContentTypeManager.IContentTypeChangeListener
public IContentType findContentTypeFor(InputStream contents, String fileName) throws IOException
Returns null
if no associated content types are
found.
If a file name is not provided, the entire content type registry will be queried. For performance reasons, it is highly recomended to provide a file name if available.
Any IOExceptions that may occur while reading the given input stream will flow to the caller. The input stream will not be closed by this operation.
contents
- an input streamfileName
- the file name associated to the contents, or null
null
IOException
- if an error occurs while reading the contentspublic IContentType findContentTypeFor(String fileName)
null
is returned.
fileName
- the name of the file
null
public IContentType[] findContentTypesFor(InputStream contents, String fileName) throws IOException
Returns an empty array if no associated content types are found.
If a file name is not provided, the entire content type registry will be queried. For performance reasons, it is highly recomended to provide a file name if available.
Any IOExceptions that may occur while reading the given input stream will flow to the caller. The input stream will not be closed by this operation.
contents
- an input streamfileName
- the file name associated to the contents, or null
IOException
- if an error occurs while reading the contentspublic IContentType[] findContentTypesFor(String fileName)
Returns an empty array if there are no content types associated.
fileName
- the name of the file
public IContentType[] getAllContentTypes()
Returns an empty array if there are no content types available.
public IContentType getContentType(String contentTypeIdentifier)
null
if no such content type is known by the platform.
contentTypeIdentifier
- the identifier for the content type
null
public IContentDescription getDescriptionFor(InputStream contents, String fileName, QualifiedName[] options) throws IOException
Any IOExceptions that may occur while reading the given input stream will flow to the caller. The input stream will not be closed by this operation.
If a file name is not provided, the entire content type registry will be queried. For performance reasons, it is highly recomended to provide a file name if available.
contents
- the contents to be interpretedfileName
- the file name associated to the contents, or null
options
- an array of keys for all properties that should be
described, or IContentDescription.ALL
, for all of them
null
IOException
- if an error occurs while reading the contentsIContentDescription
public IContentDescription getDescriptionFor(Reader contents, String fileName, QualifiedName[] options) throws IOException
Any IOExceptions that may occur while reading the given input stream will flow to the caller. The reader will not be closed by this operation.
If a file name is not provided, the entire content type registry will be queried. For performance reasons, it is highly recomended to provide a file name if available.
contents
- the contents to be interpretedfileName
- the file name associated to the contents, or null
options
- an array of keys for all properties that should be
described, or IContentDescription.ALL
, for all of them
null
IOException
- if an error occurs while reading the contentsIContentDescription
public void removeContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener listener)
null
.
listener
- the content type change listener to removeaddContentTypeChangeListener(IContentTypeManager.IContentTypeChangeListener)
,
IContentTypeManager.IContentTypeChangeListener
|
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.