Java Doc for CharSet.java in  » Library » Apache-common-lang » org » apache » commons » lang » 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 » Library » Apache common lang » org.apache.commons.lang 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.lang.CharSet

CharSet
public class CharSet implements Serializable(Code)

A set of characters.

Instances are immutable, but instances of subclasses may not be.


author:
   Stephen Colebourne
author:
   Phil Steitz
author:
   Pete Gieser
author:
   Gary Gregory
since:
   1.0
version:
   $Id: CharSet.java 471626 2006-11-06 04:02:09Z bayard $


Field Summary
final public static  CharSetASCII_ALPHA
     A CharSet defining ASCII alphabetic characters "a-zA-Z".
final public static  CharSetASCII_ALPHA_LOWER
     A CharSet defining ASCII alphabetic characters "a-z".
final public static  CharSetASCII_ALPHA_UPPER
     A CharSet defining ASCII alphabetic characters "A-Z".
final public static  CharSetASCII_NUMERIC
     A CharSet defining ASCII alphabetic characters "0-9".
final protected static  MapCOMMON
     A Map of the common cases used in the factory.
final public static  CharSetEMPTY
     A CharSet defining no characters.

Constructor Summary
protected  CharSet(String setStr)
    
protected  CharSet(String[] set)
    

Constructs a new CharSet using the set syntax.


Method Summary
protected  voidadd(String str)
    
public  booleancontains(char ch)
    
public  booleanequals(Object obj)
    
public  CharRange[]getCharRanges()
    
public static  CharSetgetInstance(String setStr)
    

Factory method to create a new CharSet using a special syntax.

  • null or empty string ("") - set containing no characters
  • Single character, such as "a" - set containing just that character
  • Multi character, such as "a-e" - set containing characters from one character to the other
  • Negated, such as "^a" or "^a-e" - set containing all characters except those defined
  • Combinations, such as "abe-g" - set containing all the characters from the individual sets

The matching order is:

  1. Negated multi character range, such as "^a-e"
  2. Ordinary multi character range, such as "a-e"
  3. Negated single character, such as "^a"
  4. Ordinary single character, such as "a"

Matching works left to right.

public  inthashCode()
    
public  StringtoString()
    

Field Detail
ASCII_ALPHA
final public static CharSet ASCII_ALPHA(Code)
A CharSet defining ASCII alphabetic characters "a-zA-Z".
since:
   2.0



ASCII_ALPHA_LOWER
final public static CharSet ASCII_ALPHA_LOWER(Code)
A CharSet defining ASCII alphabetic characters "a-z".
since:
   2.0



ASCII_ALPHA_UPPER
final public static CharSet ASCII_ALPHA_UPPER(Code)
A CharSet defining ASCII alphabetic characters "A-Z".
since:
   2.0



ASCII_NUMERIC
final public static CharSet ASCII_NUMERIC(Code)
A CharSet defining ASCII alphabetic characters "0-9".
since:
   2.0



COMMON
final protected static Map COMMON(Code)
A Map of the common cases used in the factory. Subclasses can add more common patterns if desired.
since:
   2.0



EMPTY
final public static CharSet EMPTY(Code)
A CharSet defining no characters.
since:
   2.0




Constructor Detail
CharSet
protected CharSet(String setStr)(Code)

Constructs a new CharSet using the set syntax.


Parameters:
  setStr - the String describing the set, may be null
since:
   2.0



CharSet
protected CharSet(String[] set)(Code)

Constructs a new CharSet using the set syntax. Each string is merged in with the set.


Parameters:
  set - Strings to merge into the initial set
throws:
  NullPointerException - if set is null




Method Detail
add
protected void add(String str)(Code)

Add a set definition string to the CharSet.


Parameters:
  str - set definition string



contains
public boolean contains(char ch)(Code)

Does the CharSet contain the specified character ch.


Parameters:
  ch - the character to check for true if the set contains the characters



equals
public boolean equals(Object obj)(Code)

Compares two CharSet objects, returning true if they represent exactly the same set of characters defined in the same way.

The two sets abc and a-c are not equal according to this method.


Parameters:
  obj - the object to compare to true if equal
since:
   2.0



getCharRanges
public CharRange[] getCharRanges()(Code)

Gets the internal set as an array of CharRange objects.

an array of immutable CharRange objects
since:
   2.0



getInstance
public static CharSet getInstance(String setStr)(Code)

Factory method to create a new CharSet using a special syntax.

  • null or empty string ("") - set containing no characters
  • Single character, such as "a" - set containing just that character
  • Multi character, such as "a-e" - set containing characters from one character to the other
  • Negated, such as "^a" or "^a-e" - set containing all characters except those defined
  • Combinations, such as "abe-g" - set containing all the characters from the individual sets

The matching order is:

  1. Negated multi character range, such as "^a-e"
  2. Ordinary multi character range, such as "a-e"
  3. Negated single character, such as "^a"
  4. Ordinary single character, such as "a"

Matching works left to right. Once a match is found the search starts again from the next character.

If the same range is defined twice using the same syntax, only one range will be kept. Thus, "a-ca-c" creates only one range of "a-c".

If the start and end of a range are in the wrong order, they are reversed. Thus "a-e" is the same as "e-a". As a result, "a-ee-a" would create only one range, as the "a-e" and "e-a" are the same.

The set of characters represented is the union of the specified ranges.

All CharSet objects returned by this method will be immutable.


Parameters:
  setStr - the String describing the set, may be null a CharSet instance
since:
   2.0



hashCode
public int hashCode()(Code)

Gets a hashCode compatible with the equals method.

a suitable hashCode
since:
   2.0



toString
public String toString()(Code)

Gets a string representation of the set.

string representation of the set



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(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.