com.sun.identity.install.tools.util.xml

Class Token

java.lang.Object

com.sun.identity.install.tools.util.xml.Token

All Implemented Interfaces:

IXMLUtilsConstants

Direct Known Subclasses:

BoundedToken, CommentToken, DoctypeToken, MetaToken, UnboundedToken, WhiteSpaceToken

public abstract class Token
extends Object
implements IXMLUtilsConstants

A Token represents a string fragment from within the XML document.

Field Summary

Fields inherited from interface com.sun.identity.install.tools.util.xml.IXMLUtilsConstants

DOCTYPE, NEW_LINE, TOKEN_TYPE_BOUNDED, TOKEN_TYPE_COMMENT, TOKEN_TYPE_DOCTYPE, TOKEN_TYPE_META, TOKEN_TYPE_UNBOUNDED, TOKEN_TYPE_WHITESPACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Token(String tokenString) Constructs a Token instance using the given string representation of the token.

Method Summary

Modifier and Type	Method and Description
protected String	getTokenString() Returns the string representation of the token
protected abstract String	getTokenTypeString()
protected void	setTokenString(String tokenString) Allows the specialized tokens to manipulate the token string as needed.
String	toDebugString() Returns a string representation of this token including any specific token related details along with it.
String	toString() Returns the string representation of this token.

Methods inherited from class java.lang.Object

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

Constructor Detail

Token

protected Token(String tokenString)

Constructs a Token instance using the given string representation of the token.

Parameters:

tokenString - the string representation of the token.

Method Detail

toString

public String toString()

Returns the string representation of this token. If an XML document parse resulted in n tokens, then concatenating the toString() of each of these tokens in the give order will result in the creation of the exact same XML document. If the token was deleted, an empty string is returned.

Overrides:

toString in class Object

Returns:

the string representation of this token, or an empty string if the token has been marked deleted.

getTokenString

protected String getTokenString()

Returns the string representation of the token

Returns:

setTokenString

protected void setTokenString(String tokenString)

Allows the specialized tokens to manipulate the token string as needed.

Parameters:

tokenString - the string representation of the token that will be set from this point onwards.

toDebugString

public String toDebugString()

Returns a string representation of this token including any specific token related details along with it.

Returns:

a string representation of this token including debug information

getTokenTypeString

protected abstract String getTokenTypeString()