Java Doc for StringTokenizer.java in  » 6.0-JDK-Modules » j2me » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.StringTokenizer

StringTokenizer
public class StringTokenizer implements Enumeration(Code)
The string tokenizer class allows an application to break a string into tokens. The tokenization method is much simpler than the one used by the StreamTokenizer class. The StringTokenizer methods do not distinguish among identifiers, numbers, and quoted strings, nor do they recognize and skip comments.

The set of delimiters (the characters that separate tokens) may be specified either at creation time or on a per-token basis.

An instance of StringTokenizer behaves in one of two ways, depending on whether it was created with the returnDelims flag having the value true or false:

  • If the flag is false, delimiter characters serve to separate tokens. A token is a maximal sequence of consecutive characters that are not delimiters.
  • If the flag is true, delimiter characters are themselves considered to be tokens. A token is thus either one delimiter character, or a maximal sequence of consecutive characters that are not delimiters.

A StringTokenizer object internally maintains a current position within the string to be tokenized. Some operations advance this current position past the characters processed.

A token is returned by taking a substring of the string that was used to create the StringTokenizer object.

The following is one example of the use of the tokenizer. The code:

 StringTokenizer st = new StringTokenizer("this is a test");
 while (st.hasMoreTokens()) {
 System.out.println(st.nextToken());
 }
 

prints the following output:

 this
 is
 a
 test
 

StringTokenizer is a legacy class that is retained for compatibility reasons although its use is discouraged in new code. It is recommended that anyone seeking this functionality use the split method of String or the java.util.regex package instead.

The following example illustrates how the String.split method can be used to break up a string into its basic tokens:

 String[] result = "this is a test".split("\\s");
 for (int x=0; x<result.length; x++)
 System.out.println(result[x]);
 

prints the following output:

 this
 is
 a
 test
 

author:
   unascribed
version:
   1.25, 02/02/00
See Also:   java.io.StreamTokenizer
since:
   JDK1.0



Constructor Summary
public  StringTokenizer(String str, String delim, boolean returnDelims)
     Constructs a string tokenizer for the specified string.
public  StringTokenizer(String str, String delim)
     Constructs a string tokenizer for the specified string.
public  StringTokenizer(String str)
     Constructs a string tokenizer for the specified string.

Method Summary
public  intcountTokens()
     Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception.
public  booleanhasMoreElements()
     Returns the same value as the hasMoreTokens method.
public  booleanhasMoreTokens()
     Tests if there are more tokens available from this tokenizer's string.
public  ObjectnextElement()
     Returns the same value as the nextToken method, except that its declared return value is Object rather than String.
public  StringnextToken()
     Returns the next token from this string tokenizer.
public  StringnextToken(String delim)
     Returns the next token in this string tokenizer's string.


Constructor Detail
StringTokenizer
public StringTokenizer(String str, String delim, boolean returnDelims)(Code)
Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens.

If the returnDelims flag is true, then the delimiter characters are also returned as tokens. Each delimiter is returned as a string of length one. If the flag is false, the delimiter characters are skipped and only serve as separators between tokens.

Note that if delim is null, this constructor does not throw an exception. However, trying to invoke other methods on the resulting StringTokenizer may result in a NullPointerException.
Parameters:
  str - a string to be parsed.
Parameters:
  delim - the delimiters.
Parameters:
  returnDelims - flag indicating whether to return the delimitersas tokens.




StringTokenizer
public StringTokenizer(String str, String delim)(Code)
Constructs a string tokenizer for the specified string. The characters in the delim argument are the delimiters for separating tokens. Delimiter characters themselves will not be treated as tokens.
Parameters:
  str - a string to be parsed.
Parameters:
  delim - the delimiters.



StringTokenizer
public StringTokenizer(String str)(Code)
Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is " \t\n\r\f": the space character, the tab character, the newline character, the carriage-return character, and the form-feed character. Delimiter characters themselves will not be treated as tokens.
Parameters:
  str - a string to be parsed.




Method Detail
countTokens
public int countTokens()(Code)
Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception. The current position is not advanced. the number of tokens remaining in the string using the currentdelimiter set.
See Also:   java.util.StringTokenizer.nextToken



hasMoreElements
public boolean hasMoreElements()(Code)
Returns the same value as the hasMoreTokens method. It exists so that this class can implement the Enumeration interface. true if there are more tokens;false otherwise.
See Also:   java.util.Enumeration
See Also:   java.util.StringTokenizer.hasMoreTokens



hasMoreTokens
public boolean hasMoreTokens()(Code)
Tests if there are more tokens available from this tokenizer's string. If this method returns true, then a subsequent call to nextToken with no argument will successfully return a token. true if and only if there is at least one token in the string after the current position; false otherwise.



nextElement
public Object nextElement()(Code)
Returns the same value as the nextToken method, except that its declared return value is Object rather than String. It exists so that this class can implement the Enumeration interface. the next token in the string.
exception:
  NoSuchElementException - if there are no more tokens in thistokenizer's string.
See Also:   java.util.Enumeration
See Also:   java.util.StringTokenizer.nextToken



nextToken
public String nextToken()(Code)
Returns the next token from this string tokenizer. the next token from this string tokenizer.
exception:
  NoSuchElementException - if there are no more tokens in thistokenizer's string.



nextToken
public String nextToken(String delim)(Code)
Returns the next token in this string tokenizer's string. First, the set of characters considered to be delimiters by this StringTokenizer object is changed to be the characters in the string delim. Then the next token in the string after the current position is returned. The current position is advanced beyond the recognized token. The new delimiter set remains the default after this call.
Parameters:
  delim - the new delimiters. the next token, after switching to the new delimiter set.
exception:
  NoSuchElementException - if there are no more tokens in thistokenizer's string.



Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.