com.whitestein.lsps.common.text

Class TextDocument

java.lang.Object

com.whitestein.lsps.common.text.TextDocument

public class TextDocument
extends Object

Author:

mvo

Constructor Summary

Constructors

Constructor and Description
TextDocument(String text)

Method Summary

Modifier and Type	Method and Description
String	getLineDelimiter(int line) Returns the line delimiter of the given line.
int	getLineLength(int line) Returns the length of the given line including the line's delimiter.
int	getLineOffset(int line) Determines the offset of the first character of the given line.
int	getLineOfOffset(int offset) Returns the number of the line at which the character of the specified position is located.
String	getLineText(int line, boolean includeDelimiter) Returns a text of the line given by its line number.
int	getNumberOfLines() Returns the number of lines in this document
int	getSmartLineStart(int offset) Returns the offset of the smart line start.
String	getText(String lineDelimiter) Returns the original text with converted line delimiters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextDocument

public TextDocument(String text)

Parameters:

text -

Method Detail

getNumberOfLines

public int getNumberOfLines()

Returns the number of lines in this document

Returns:

the number of lines in this document

getLineOffset

public int getLineOffset(int line)

Determines the offset of the first character of the given line.

Parameters:

line - the line of interest

Returns:

the document offset

getLineLength

public int getLineLength(int line)

Returns the length of the given line including the line's delimiter.

Parameters:

line - the line of interest

Returns:

the length of the line

getLineDelimiter

public String getLineDelimiter(int line)

Returns the line delimiter of the given line.

The method returns null for the last line.

Parameters:

line - the line of interest

Returns:

the line delimiter, may be null

getLineOfOffset

public int getLineOfOffset(int offset)

Returns the number of the line at which the character of the specified position is located. The first line has the line number 0. A new line starts directly after a line delimiter.

Parameters:

offset - the document offset

Returns:

the number of the line

getLineText

public String getLineText(int line,
                          boolean includeDelimiter)

Returns a text of the line given by its line number.

Parameters:

line -

includeDelimiter - specifies whether to include a line delimiter

Returns:

the text of the line

getSmartLineStart

public int getSmartLineStart(int offset)

Returns the offset of the smart line start. It is the offset of the first non-whitespace character in the line.

Parameters:

offset -

Returns:

the offset of the smart line start

getText

public String getText(String lineDelimiter)

Returns the original text with converted line delimiters.

Parameters:

lineDelimiter -

Returns:

the text with converted line delimiter