org.eclipse.jface.text.source

Class FastJavaLikePartitionScanner

java.lang.Object

org.eclipse.jface.text.source.FastJavaLikePartitionScanner

All Implemented Interfaces:

IPartitionTokenScanner, ITokenScanner

public class FastJavaLikePartitionScanner
extends java.lang.Object
implements IPartitionTokenScanner

This scanner recognizes the JavaDoc comments, Java multi line comments, Java single line comments, Java strings and Java characters.

Constructor Summary

Constructors

Constructor and Description
FastJavaLikePartitionScanner(java.lang.String singleLineCommentKey, java.lang.String multiLineCommentKey, java.lang.String javaDocKey, java.lang.String characterKey, java.lang.String stringKey)

Method Summary

Modifier and Type	Method and Description
int	getTokenLength() Returns the length of the last token read by this scanner.
int	getTokenOffset() Returns the offset of the last token read by this scanner.
IToken	nextToken() Returns the next token in the document.
void	setPartialRange(IDocument document, int offset, int length, java.lang.String contentType, int partitionOffset) Configures the scanner by providing access to the document range that should be scanned.
void	setRange(IDocument document, int offset, int length) Configures the scanner by providing access to the document range that should be scanned.

Methods inherited from class java.lang.Object

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

Constructor Detail

FastJavaLikePartitionScanner

public FastJavaLikePartitionScanner(java.lang.String singleLineCommentKey,
                                    java.lang.String multiLineCommentKey,
                                    java.lang.String javaDocKey,
                                    java.lang.String characterKey,
                                    java.lang.String stringKey)

Method Detail

nextToken

public IToken nextToken()

Description copied from interface: ITokenScanner

Returns the next token in the document.

Specified by:

nextToken in interface ITokenScanner

Returns:

the next token in the document

setPartialRange

public void setPartialRange(IDocument document,
                            int offset,
                            int length,
                            java.lang.String contentType,
                            int partitionOffset)

Description copied from interface: IPartitionTokenScanner

Configures the scanner by providing access to the document range that should be scanned. The range may not only contain complete partitions but starts at the beginning of a line in the middle of a partition of the given content type. This requires that a partition delimiter can not contain a line delimiter.

Specified by:

setPartialRange in interface IPartitionTokenScanner

Parameters:

document - the document to scan

offset - the offset of the document range to scan

length - the length of the document range to scan

contentType - the content type at the given offset

partitionOffset - the offset at which the partition of the given offset starts

setRange

public void setRange(IDocument document,
                     int offset,
                     int length)

Description copied from interface: ITokenScanner

Configures the scanner by providing access to the document range that should be scanned.

Specified by:

setRange in interface ITokenScanner

Parameters:

document - the document to scan

offset - the offset of the document range to scan

length - the length of the document range to scan

getTokenLength

public int getTokenLength()

Description copied from interface: ITokenScanner

Returns the length of the last token read by this scanner.

Specified by:

getTokenLength in interface ITokenScanner

Returns:

the length of the last token read by this scanner

getTokenOffset

public int getTokenOffset()

Description copied from interface: ITokenScanner

Returns the offset of the last token read by this scanner.

Specified by:

getTokenOffset in interface ITokenScanner

Returns:

the offset of the last token read by this scanner