Eclipse Platform
2.1

org.eclipse.jface.text
Class TextUtilities

java.lang.Object
  |
  +--org.eclipse.jface.text.TextUtilities

public class TextUtilities
extends Object

Collection of text functions.


Field Summary
static String[] fgDelimiters
           
 
Constructor Summary
TextUtilities()
           
 
Method Summary
static String determineLineDelimiter(String text, String hint)
          Determines which one of fgDelimiters appears first in the list.
static int endsWith(String[] searchStrings, String text)
          Returns the longest search string with which the given text ends.
static int equals(String[] compareStrings, String text)
          Returns whether the text equals one of the given compare strings.
static int[] indexOf(String[] searchStrings, String text, int offset)
          Returns the position in the string greater than offset of the longest matching search string.
static DocumentEvent mergeProcessedDocumentEvents(List documentEvents)
          Returns a document event which is an accumulation of a list of document events, null if the list of document events is empty.
static DocumentEvent mergeUnprocessedDocumentEvents(IDocument unprocessedDocument, List documentEvents)
          Returns a document event which is an accumulation of a list of document events, null if the list of documentEvents is empty.
static int startsWith(String[] searchStrings, String text)
          Returns the longest search string with which the given text starts.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fgDelimiters

public static final String[] fgDelimiters
Constructor Detail

TextUtilities

public TextUtilities()
Method Detail

determineLineDelimiter

public static String determineLineDelimiter(String text,
                                            String hint)
Determines which one of fgDelimiters appears first in the list. If none of them the hint is returned.


indexOf

public static int[] indexOf(String[] searchStrings,
                            String text,
                            int offset)
Returns the position in the string greater than offset of the longest matching search string.


endsWith

public static int endsWith(String[] searchStrings,
                           String text)
Returns the longest search string with which the given text ends.


startsWith

public static int startsWith(String[] searchStrings,
                             String text)
Returns the longest search string with which the given text starts.


equals

public static int equals(String[] compareStrings,
                         String text)
Returns whether the text equals one of the given compare strings.


mergeUnprocessedDocumentEvents

public static DocumentEvent mergeUnprocessedDocumentEvents(IDocument unprocessedDocument,
                                                           List documentEvents)
                                                    throws BadLocationException
Returns a document event which is an accumulation of a list of document events, null if the list of documentEvents is empty. The document of the document events are ignored.

Parameters:
unprocessedDocument - the document to which the document events would be applied
documentEvents - the list of document events to merge
Returns:
returns the merged document event
Throws:
BadLocationException - might be thrown if document is not in the correct state with respect to document events

mergeProcessedDocumentEvents

public static DocumentEvent mergeProcessedDocumentEvents(List documentEvents)
                                                  throws BadLocationException
Returns a document event which is an accumulation of a list of document events, null if the list of document events is empty. The document events being merged must all refer to the same document, to which the document changes have been already applied.

Parameters:
documentEvents - the list of document events to merge
Returns:
returns the merged document event
Throws:
BadLocationException - might be thrown if document is not in the correct state with respect to document events

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.