uk.ac.ed.ph.snuggletex.internal

Class FrozenSlice

java.lang.Object

uk.ac.ed.ph.snuggletex.internal.FrozenSlice

public final class FrozenSlice
extends Object

Represents a finished "segment" of text in the WorkingDocument. This represents the document after ALL text substitutions have been made so ought to be considered as representing a fixed block of text.

This is used to represent the block of text each parsed Token refers to.

Developer Note

At one point in LaTeXTokeniser, it is technically possible to have a FrozenSlice which may refer to text which could change, but this phenomenon is temporary.

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
WorkingDocument	document
int	endIndex
int	startIndex

Constructor Summary

Constructors

Constructor and Description
FrozenSlice(WorkingDocument document, int startIndex, int endIndex)

Method Summary

Modifier and Type	Method and Description
protected void	ensureSharesDocumentWith(FrozenSlice otherSlice)
CharSequence	extract()
WorkingDocument	getDocument()
int	getEndIndex()
int	getStartIndex()
boolean	isWhitespace()
FrozenSlice	rightOuterSpan(FrozenSlice rightSlice)
boolean	sharesDocumentWith(FrozenSlice otherSlice)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

document

public final WorkingDocument document

startIndex

public final int startIndex

endIndex

public final int endIndex

Constructor Detail

FrozenSlice

public FrozenSlice(WorkingDocument document,
                   int startIndex,
                   int endIndex)

Method Detail

getDocument

public WorkingDocument getDocument()

getStartIndex

public int getStartIndex()

getEndIndex

public int getEndIndex()

extract

public CharSequence extract()

isWhitespace

public boolean isWhitespace()

rightOuterSpan

public FrozenSlice rightOuterSpan(FrozenSlice rightSlice)

sharesDocumentWith

public final boolean sharesDocumentWith(FrozenSlice otherSlice)

ensureSharesDocumentWith

protected final void ensureSharesDocumentWith(FrozenSlice otherSlice)

toString

public String toString()

Overrides:

toString in class Object