org.eclipse.xtext.parser.packrat.matching

Class StringWithOffset

java.lang.Object

org.eclipse.xtext.parser.packrat.matching.StringWithOffset

All Implemented Interfaces:

CharSequence, ICharSequenceWithOffset, IMarkerFactory

public class StringWithOffset
extends Object
implements ICharSequenceWithOffset, IMarkerFactory

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.parser.packrat.IMarkerFactory

IMarkerFactory.IMarker

Constructor Summary

Constructors

Constructor and Description
StringWithOffset(String value)

Method Summary

Methods

Modifier and Type	Method and Description
char	charAt(int index)
int	getOffset() Retrieves the current state of the offset property.
void	incOffset() Increments the offset by one.
void	incOffset(int amount) Increments the offset by the given amount.
int	length()
IMarkerFactory.IMarker	mark() Creates a new marker.
void	setOffset(int offset) Random access to modify the offset.
CharSequence	subSequence(int start, int end)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

toString

Constructor Detail

StringWithOffset

public StringWithOffset(String value)

Method Detail

getOffset

public int getOffset()

Description copied from interface: ICharSequenceWithOffset

Retrieves the current state of the offset property.

Specified by:

getOffset in interface ICharSequenceWithOffset

Returns:

the current offset.

incOffset

public void incOffset()

Description copied from interface: ICharSequenceWithOffset

Increments the offset by one.

Specified by:

incOffset in interface ICharSequenceWithOffset

incOffset

public void incOffset(int amount)

Description copied from interface: ICharSequenceWithOffset

Increments the offset by the given amount. Can be used to decrement the offset.

Specified by:

incOffset in interface ICharSequenceWithOffset

Parameters:

amount - the number of offset that should be shifted.

setOffset

public void setOffset(int offset)

Description copied from interface: ICharSequenceWithOffset

Random access to modify the offset. Can be set independently from the length of the char sequence.

Specified by:

setOffset in interface ICharSequenceWithOffset

Parameters:

offset - the new offset.

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

length

public int length()

Specified by:

length in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                       int end)

Specified by:

subSequence in interface CharSequence

mark

public IMarkerFactory.IMarker mark()

Description copied from interface: IMarkerFactory

Creates a new marker.

Specified by:

mark in interface IMarkerFactory

Returns:

the created marker.