Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.core.filebuffers
Interface ITextFileBufferManager

All Superinterfaces:
IFileBufferManager

public interface ITextFileBufferManager
extends IFileBufferManager

A text file buffer manager manages text file buffers for files whose contents is considered text.

Clients are not supposed to implement that interface.

Since:
3.0
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

Field Summary
static  ITextFileBufferManager DEFAULT
          The default text file buffer manager.
 
Method Summary
  IAnnotationModel createAnnotationModel ( IPath location)
          Deprecated. As of 3.3, replaced by createAnnotationModel(IPath, LocationKind)
  IAnnotationModel createAnnotationModel ( IPath location, LocationKind locationKind)
          Creates a new annotation for the given location.
  IDocument createEmptyDocument ( IPath location)
          Deprecated. As of 3.3, replaced by createEmptyDocument(IPath, LocationKind)
  IDocument createEmptyDocument ( IPath location, LocationKind locationKind)
          Creates a new empty document.
  String getDefaultEncoding ()
          Returns the default encoding that is used to read the contents of text files if no other encoding is specified.
  ITextFileBuffer getFileStoreTextFileBuffer ( IFileStore fileStore)
          Returns the text file buffer managed for the given file store or null if there is no such text file buffer.
  ITextFileBuffer getTextFileBuffer ( IDocument document)
          Returns the text file buffer managed for the given document or null if there is no such text file buffer.
  ITextFileBuffer getTextFileBuffer ( IPath location)
          Deprecated. As of 3.3, replaced by getTextFileBuffer(IPath, LocationKind)
  ITextFileBuffer getTextFileBuffer ( IPath location, LocationKind locationKind)
          Returns the text file buffer managed for the file at the given location or null if there is no such text file buffer.
 boolean isTextFileLocation ( IPath location)
          Deprecated. As of 3.2, replaced by isTextFileLocation(IPath, boolean)
 boolean isTextFileLocation ( IPath location, boolean strict)
          Returns whether a file at the given location is or can be considered a text file.
 
Methods inherited from interface org.eclipse.core.filebuffers. IFileBufferManager
addFileBufferListener, connect, connect, connectFileStore, disconnect, disconnect, disconnectFileStore, execute, getFileBuffer, getFileBuffer, getFileBuffers, getFileStoreFileBuffer, getFileStoreFileBuffers, releaseSynchronizationContext, removeFileBufferListener, requestSynchronizationContext, setSynchronizationContext, validateState
 

Field Detail

DEFAULT

static final 
ITextFileBufferManager DEFAULT
The default text file buffer manager.

Since:
3.3
Method Detail

getTextFileBuffer

ITextFileBuffer getTextFileBuffer(
IPath location)
Deprecated. As of 3.3, replaced by getTextFileBuffer(IPath, LocationKind)

Returns the text file buffer managed for the file at the given location or null if either there is no such text file buffer.

The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.

Parameters:
location - the location
Returns:
the text file buffer managed for that location or null

getTextFileBuffer

ITextFileBuffer getTextFileBuffer(
IPath location,
                                  
LocationKind locationKind)
Returns the text file buffer managed for the file at the given location or null if there is no such text file buffer.

The type of the provided location is specified by the given locationKind.

Parameters:
location - the location
locationKind - the kind of the given location
Returns:
the text file buffer managed for that location or null
Since:
3.3
See Also:
LocationKind

getFileStoreTextFileBuffer

ITextFileBuffer getFileStoreTextFileBuffer(
IFileStore fileStore)
Returns the text file buffer managed for the given file store or null if there is no such text file buffer.

Note: This API must not be used if the given file store maps to a resource contained in the workspace. A file buffer that has been connected using a path will not be found.

We had to use a different name than getTextFileBuffer for this method due to https://bugs.eclipse.org/bugs/show_bug.cgi?id=148844

Parameters:
fileStore - the file store
Returns:
the text file buffer managed for that file store or null
Since:
3.3

getTextFileBuffer

ITextFileBuffer getTextFileBuffer(
IDocument document)
Returns the text file buffer managed for the given document or null if there is no such text file buffer.

Note: This method goes through the list of registered buffers and tests whether its document matches the given one. Therefore this method should not be used in performance critical code.

Parameters:
document - the document for which to find the text file buffer
Returns:
the text file buffer managed for that document or null
Since:
3.3

getDefaultEncoding

String getDefaultEncoding()
Returns the default encoding that is used to read the contents of text files if no other encoding is specified.

Returns:
the default text file encoding

createEmptyDocument

IDocument createEmptyDocument(
IPath location)
Deprecated. As of 3.3, replaced by createEmptyDocument(IPath, LocationKind)

Creates a new empty document. The document is set up in the same way as it would be used in a text file buffer for a file at the given location.

The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.

Parameters:
location - the location used to set up the newly created document or null if unknown
Returns:
a new empty document

createEmptyDocument

IDocument createEmptyDocument(
IPath location,
                              
LocationKind locationKind)
Creates a new empty document. The document is set up in the same way as it would be used in a text file buffer for a file at the given location.

The type of the provided location is specified by the given locationKind.

Parameters:
location - the location used to set up the newly created document or null if unknown
locationKind - the kind of the given location
Returns:
a new empty document
Since:
3.3

createAnnotationModel

IAnnotationModel createAnnotationModel(
IPath location)
Deprecated. As of 3.3, replaced by createAnnotationModel(IPath, LocationKind)

Creates a new annotation for the given location.

The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.

Parameters:
location - the location used to create the new annotation model
Returns:
the newly created annotation model

createAnnotationModel

IAnnotationModel createAnnotationModel(
IPath location,
                                       
LocationKind locationKind)
Creates a new annotation for the given location.

The type of the provided location is specified by the given locationKind.

Parameters:
location - the location used to create the new annotation model
locationKind - the kind of the given location
Returns:
the newly created annotation model
Since:
3.3

isTextFileLocation

boolean isTextFileLocation(
IPath location)
Deprecated. As of 3.2, replaced by isTextFileLocation(IPath, boolean)

Returns whether a file at the given location is or can be considered a text file. If the file exists, the concrete content type of the file is checked. If the concrete content type for the existing file can not be determined, this method returns true. If the file does not exist, it is checked whether a text content type is associated with the given location. If no content type is associated with the location, this method returns true.

The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.

Parameters:
location - the location to check
Returns:
true if the location is a text file location
Since:
3.1

isTextFileLocation

boolean isTextFileLocation(
IPath location,
                           boolean strict)
Returns whether a file at the given location is or can be considered a text file. If the file exists, the concrete content type of the file is checked. If the concrete content type for the existing file can not be determined, this method returns !strict. If the file does not exist, it is checked whether a text content type is associated with the given location. If no content type is associated with the location, this method returns !strict.

The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.

Parameters:
location - the location to check
strict - true if a file with unknown content type is not treated as text file, false otherwise
Returns:
true if the location is a text file location
Since:
3.2

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire