org.aspectj.org.eclipse.jdt.internal.formatter

Class Token

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.formatter.Token

public class Token
extends java.lang.Object

Stores a token's type, position and all its properties like surrounding whitespace, wrapping behavior and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Token.WrapMode
static class	Token.WrapPolicy

Field Summary

Fields

Modifier and Type	Field and Description
int	originalEnd Position in source of the last character (this position is included in the token).
int	originalStart Position in source of the first character.
int	tokenType Type of this token.

Constructor Summary

Constructors

Constructor and Description
Token(int sourceStart, int sourceEnd, int tokenType)
Token(Token tokenToCopy)
Token(Token tokenToCopy, int newOriginalStart, int newOriginalEnd, int newTokenType)

Method Summary

Modifier and Type	Method and Description
void	breakAfter()
void	breakBefore()
void	clearLineBreaksAfter()
void	clearLineBreaksBefore()
void	clearSpaceAfter() Removes space after this token
void	clearSpaceBefore() Removes space before this token
int	countChars()
static Token	fromCurrent(Scanner scanner, int currentToken)
int	getAlign()
int	getEmptyLineIndentAdjustment()
int	getIndent()
java.util.List<Token>	getInternalStructure()
int	getLineBreaksAfter()
int	getLineBreaksBefore()
Token	getNLSTag()
Token.WrapPolicy	getWrapPolicy()
boolean	hasNLSTag()
void	indent() Increases this token's indentation by one position
boolean	isComment()
boolean	isNextLineOnWrap()
boolean	isPreserveLineBreaksAfter()
boolean	isPreserveLineBreaksBefore()
boolean	isSpaceAfter()
boolean	isSpaceBefore()
boolean	isToEscape()
boolean	isWrappable()
void	putLineBreaksAfter(int lineBreaks)
void	putLineBreaksBefore(int lineBreaks)
void	setAlign(int align)
void	setEmptyLineIndentAdjustment(int adjustment)
void	setIndent(int indent)
void	setInternalStructure(java.util.List<Token> internalStructure)
void	setNextLineOnWrap()
void	setNLSTag(Token nlsTagToken)
void	setPreserveLineBreaksAfter(boolean preserveLineBreaksAfter)
void	setPreserveLineBreaksBefore(boolean preserveLineBreaksBefore)
void	setToEscape(boolean shouldEscape)
void	setWrapped(boolean wrapped) Can be used to temporarily force preceding line break without losing the original number of line breaks.
void	setWrapPolicy(Token.WrapPolicy wrapPolicy)
void	spaceAfter() Adds space after this token
void	spaceBefore() Adds space before this token
java.lang.String	toString()
java.lang.String	toString(java.lang.String source)
void	unindent() Decreses this token's indentation by one position

Methods inherited from class java.lang.Object

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

Field Detail

originalStart

public final int originalStart

Position in source of the first character.

originalEnd

public final int originalEnd

Position in source of the last character (this position is included in the token).

tokenType

public final int tokenType

Type of this token. See TerminalTokens for constants definition.

Constructor Detail

Token

public Token(int sourceStart,
             int sourceEnd,
             int tokenType)

Token

public Token(Token tokenToCopy)

Token

public Token(Token tokenToCopy,
             int newOriginalStart,
             int newOriginalEnd,
             int newTokenType)

Method Detail

fromCurrent

public static Token fromCurrent(Scanner scanner,
                                int currentToken)

spaceBefore

public void spaceBefore()

Adds space before this token

clearSpaceBefore

public void clearSpaceBefore()

Removes space before this token

isSpaceBefore

public boolean isSpaceBefore()

spaceAfter

public void spaceAfter()

Adds space after this token

clearSpaceAfter

public void clearSpaceAfter()

Removes space after this token

isSpaceAfter

public boolean isSpaceAfter()

breakBefore

public void breakBefore()

putLineBreaksBefore

public void putLineBreaksBefore(int lineBreaks)

getLineBreaksBefore

public int getLineBreaksBefore()

setWrapped

public void setWrapped(boolean wrapped)

Can be used to temporarily force preceding line break without losing the original number of line breaks.

clearLineBreaksBefore

public void clearLineBreaksBefore()

breakAfter

public void breakAfter()

putLineBreaksAfter

public void putLineBreaksAfter(int lineBreaks)

getLineBreaksAfter

public int getLineBreaksAfter()

clearLineBreaksAfter

public void clearLineBreaksAfter()

setPreserveLineBreaksBefore

public void setPreserveLineBreaksBefore(boolean preserveLineBreaksBefore)

isPreserveLineBreaksBefore

public boolean isPreserveLineBreaksBefore()

setPreserveLineBreaksAfter

public void setPreserveLineBreaksAfter(boolean preserveLineBreaksAfter)

isPreserveLineBreaksAfter

public boolean isPreserveLineBreaksAfter()

indent

public void indent()

Increases this token's indentation by one position

unindent

public void unindent()

Decreses this token's indentation by one position

setIndent

public void setIndent(int indent)

getIndent

public int getIndent()

setEmptyLineIndentAdjustment

public void setEmptyLineIndentAdjustment(int adjustment)

getEmptyLineIndentAdjustment

public int getEmptyLineIndentAdjustment()

setAlign

public void setAlign(int align)

getAlign

public int getAlign()

setToEscape

public void setToEscape(boolean shouldEscape)

isToEscape

public boolean isToEscape()

setNextLineOnWrap

public void setNextLineOnWrap()

isNextLineOnWrap

public boolean isNextLineOnWrap()

setWrapPolicy

public void setWrapPolicy(Token.WrapPolicy wrapPolicy)

getWrapPolicy

public Token.WrapPolicy getWrapPolicy()

isWrappable

public boolean isWrappable()

setNLSTag

public void setNLSTag(Token nlsTagToken)

hasNLSTag

public boolean hasNLSTag()

getNLSTag

public Token getNLSTag()

setInternalStructure

public void setInternalStructure(java.util.List<Token> internalStructure)

getInternalStructure

public java.util.List<Token> getInternalStructure()

isComment

public boolean isComment()

toString

public java.lang.String toString(java.lang.String source)

countChars

public int countChars()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object