Class StringTokenizer

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.util.StringTokenizer

All Implemented Interfaces:

Cloneable, Tokenizer

Direct Known Subclasses:

TokenFilter.StringTokenizer

public class StringTokenizer
extends ProjectComponent
implements Tokenizer

Class to tokenize the input as areas separated by white space, or by a specified list of delim characters. Behaves like java.util.StringTokenizer. If the stream starts with delim characters, the first token will be an empty string (unless the treat delims as tokens flag is set).

Since:

Ant 1.7

Field Summary

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
StringTokenizer()

Method Summary

Modifier and Type	Method	Description
String	getPostToken()	return the string between tokens, after the previous token.
String	getToken(Reader in)	find and return the next token
void	setDelims(String delims)	attribute delims - the delimiter characters
void	setDelimsAreTokens(boolean delimsAreTokens)	attribute delimsaretokens - treat delimiters as separate tokens.
void	setIncludeDelims(boolean includeDelims)	attribute includedelims - treat delimiters as part of the token.
void	setSuppressDelims(boolean suppressDelims)	attribute suppressdelims - suppress delimiters.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

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

Constructor Details

StringTokenizer

public StringTokenizer()

Method Details

setDelims

public void setDelims(String delims)

attribute delims - the delimiter characters

Parameters:

delims - a string containing the delimiter characters

setDelimsAreTokens

public void setDelimsAreTokens(boolean delimsAreTokens)

attribute delimsaretokens - treat delimiters as separate tokens.

Parameters:

delimsAreTokens - true if delimiters are to be separate

setSuppressDelims

public void setSuppressDelims(boolean suppressDelims)

attribute suppressdelims - suppress delimiters. default - false

Parameters:

suppressDelims - if true do not report delimiters

setIncludeDelims

public void setIncludeDelims(boolean includeDelims)

attribute includedelims - treat delimiters as part of the token. default - false

Parameters:

includeDelims - if true add delimiters to the token

getToken

public String getToken(Reader in)
                throws IOException

find and return the next token

Specified by:

getToken in interface Tokenizer

Parameters:

in - the input stream

Returns:

the token

Throws:

IOException - if an error occurs reading

getPostToken

public String getPostToken()

Description copied from interface: Tokenizer

return the string between tokens, after the previous token.

Specified by:

getPostToken in interface Tokenizer

Returns:

the intratoken string