ro.sync.outline

Class TokenItem

java.lang.Object

ro.sync.outline.TokenItem

All Implemented Interfaces:

java.lang.Comparable

@API(type=EXTENDABLE,
     src=PRIVATE)
public abstract class TokenItem
extends java.lang.Object
implements java.lang.Comparable

Base class for tokens used in tokenizing document lines. Note: this class has a natural ordering that is inconsistent with equals.

Field Summary

Fields

Modifier and Type	Field and Description
protected TokenItem	parent The parent token.

Constructor Summary

Constructors

Constructor and Description
TokenItem(int column, java.lang.String value) Make a private copy of type, column, value.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canBeNode() Returns true if the token item can be a tree node.
boolean	canHaveAttributes() Checks if the token can have attributes.
int	compareTo(java.lang.Object o) Implements the compareTo() method of the Comparable interface.
boolean	equals(java.lang.Object o) Find if the specified object is a TokenItem with the same line and column.
int	getColumn() Get the column where the item is located.
int	getLength() Get the token's length.
int	getLine() Get the line of this token.
abstract TokenItem	getMatchingTokenItem() Get the maching token item.
java.lang.String	getName() Get the name of the token, filtering the special characters like from the TokenItem value.
TokenItem	getParent() Get the parent of the token item.
abstract int	getType() Get the token's type.
java.lang.String	getValue() Get the current value of this token.
int	hashCode()
abstract boolean	isEnd()
boolean	isIgnorable() Checks if a token item is ignorable.
abstract boolean	isStart()
void	moveContext(ro.sync.outline.ProcessingContext context) Moves only the current item and/or the previous item in context.
void	setColumn(int column) Set the start column of this token.
void	setLT(ro.sync.outline.LineTokens lt) Set the line for this token.
void	setParent(TokenItem parent)
void	setValue(java.lang.String value) Set the value of this token.
java.lang.String	toString()
void	unbind() Notifies a token item that it is removed.
boolean	update(ro.sync.outline.ProcessingContext context) Updates the processing context and eventual items so that the current item is inserted in the current context.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

parent

protected TokenItem parent

The parent token.

Constructor Detail

TokenItem

public TokenItem(int column,
                 java.lang.String value)

Make a private copy of type, column, value.

Parameters:

column - The start column of the token.

value - The length of the token.

Method Detail

setLT

public void setLT(ro.sync.outline.LineTokens lt)

Set the line for this token.

Parameters:

lt - The line this token belongs to.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

@see java.lang.Object#toString()

getColumn

public int getColumn()

Get the column where the item is located. This is a text coordonate, 0 at the left of the line.

Returns:

The text column in the line of this token item. 0 based.

setColumn

public void setColumn(int column)

Set the start column of this token.

Parameters:

column - The start column of this token. 0 based.

getLength

public int getLength()

Get the token's length.

Returns:

The length of this token.

getType

public abstract int getType()

Get the token's type. Must be a constant defined in XmlTokenFactory

Returns:

type of token

setValue

public void setValue(java.lang.String value)

Set the value of this token.

Parameters:

value - The value to be set for this token.

getLine

public int getLine()

Get the line of this token.

Returns:

The line of this token. 0 based.

getValue

public java.lang.String getValue()

Get the current value of this token.

Returns:

The value of the token.

getName

public java.lang.String getName()

Get the name of the token, filtering the special characters like from the TokenItem value.

Returns:

The name of the token.

compareTo

public int compareTo(java.lang.Object o)

Implements the compareTo() method of the Comparable interface.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this Object.

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object o)

Find if the specified object is a TokenItem with the same line and column.

Overrides:

equals in class java.lang.Object

Parameters:

o - The specified object to be tested for equality

Returns:

True if the specified object is a TokenItem with the same line and column.

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

update

public boolean update(ro.sync.outline.ProcessingContext context)

Updates the processing context and eventual items so that the current item is inserted in the current context. Called when lines are tokenized and when document is changed.

Parameters:

context - The context this item is added on.

Returns:

True if the update must continue with the next node, or false if the update leaves the node in the same state and no further update is necessary. Subclasses must change from the default impl which returns true if it is the case.

moveContext

public void moveContext(ro.sync.outline.ProcessingContext context)

Moves only the current item and/or the previous item in context. Empty implementation. The subclasses must implement it.

Parameters:

context - The context this item is added on.

getParent

public final TokenItem getParent()

Get the parent of the token item.

Returns:

Returns the parent.

setParent

public void setParent(TokenItem parent)

Parameters:

parent - The parent to set.

canBeNode

public abstract boolean canBeNode()

Returns true if the token item can be a tree node.

Returns:

true if the token item can be a tree node.

unbind

public void unbind()

Notifies a token item that it is removed. By default empty implementation. Subclasses must change this. The token item should do whatever processing is necesary to clean up.

isStart

public abstract boolean isStart()

Returns:

true if the token is a start of a logical block.

isEnd

public abstract boolean isEnd()

Returns:

true if the token is an end of a logical block.

isIgnorable

public boolean isIgnorable()

Checks if a token item is ignorable. For instance comments, PIs are considered ignorable.

Returns:

true if ignorable, false otherwise.

canHaveAttributes

public boolean canHaveAttributes()

Checks if the token can have attributes.

Returns:

false. Subclasses may return true.

getMatchingTokenItem

public abstract TokenItem getMatchingTokenItem()

Get the maching token item. For example if this is an opening of a tag, the match will be the end tag. If this is an end tag, then the match can be the openning.

Returns:

The maching token item, or null if the ti could not be determined.