Java Doc for CharsetToolkit.java in  » Scripting » groovy-1.0 » groovy » 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 » Scripting » groovy 1.0 » groovy.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   groovy.util.CharsetToolkit

CharsetToolkit
public class CharsetToolkit (Code)

Utility class to guess the encoding of a given text file.

Unicode files encoded in UTF-16 (low or big endian) or UTF-8 files with a Byte Order Marker are correctly discovered. For UTF-8 files with no BOM, if the buffer is wide enough, the charset should also be discovered.

A byte buffer of 4KB is usually sufficient to be able to guess the encoding.

Usage:

 // guess the encoding
 Charset guessedCharset = CharsetToolkit.guessEncoding(file, 4096);
 // create a reader with the correct charset
 CharsetToolkit toolkit = new CharsetToolkit(file);
 BufferedReader reader = toolkit.getReader();
 // read the file content
 String line;
 while ((line = br.readLine())!= null)
 {
 System.out.println(line);
 }
 

author:
   Guillaume Laforge



Constructor Summary
public  CharsetToolkit(File file)
     Constructor of the CharsetToolkit utility class.

Method Summary
public static  Charset[]getAvailableCharsets()
     Retrieves all the available Charsets on the platform, among which the default charset.
public  CharsetgetCharset()
    
public  CharsetgetDefaultCharset()
    
public static  CharsetgetDefaultSystemCharset()
     Retrieve the default charset of the system.
public  booleangetEnforce8Bit()
     Gets the enforce8Bit flag, in case we do not want to ever get a US-ASCII encoding.
public  BufferedReadergetReader()
     Gets a BufferedReader (indeed a LineNumberReader) from the File specified in the constructor of CharsetToolkit using the charset discovered by the method guessEncoding().
public  booleanhasUTF16BEBom()
     Has a Byte Order Marker for UTF-16 Big Endian (utf-16 and ucs-2).
public  booleanhasUTF16LEBom()
     Has a Byte Order Marker for UTF-16 Low Endian (ucs-2le, ucs-4le, and ucs-16le).
public  booleanhasUTF8Bom()
     Has a Byte Order Marker for UTF-8 (Used by Microsoft's Notepad and other editors).
public  voidsetDefaultCharset(Charset defaultCharset)
     Defines the default Charset used in case the buffer represents an 8-bit Charset.
public  voidsetEnforce8Bit(boolean enforce)
     If US-ASCII is recognized, enforce to return the default encoding, rather than US-ASCII.


Constructor Detail
CharsetToolkit
public CharsetToolkit(File file) throws IOException(Code)
Constructor of the CharsetToolkit utility class.
Parameters:
  file - of which we want to know the encoding.




Method Detail
getAvailableCharsets
public static Charset[] getAvailableCharsets()(Code)
Retrieves all the available Charsets on the platform, among which the default charset. an array of Charsets.



getCharset
public Charset getCharset()(Code)



getDefaultCharset
public Charset getDefaultCharset()(Code)
Retrieves the default Charset



getDefaultSystemCharset
public static Charset getDefaultSystemCharset()(Code)
Retrieve the default charset of the system. the default Charset.



getEnforce8Bit
public boolean getEnforce8Bit()(Code)
Gets the enforce8Bit flag, in case we do not want to ever get a US-ASCII encoding. a boolean representing the flag of use of US-ASCII.



getReader
public BufferedReader getReader() throws FileNotFoundException(Code)
Gets a BufferedReader (indeed a LineNumberReader) from the File specified in the constructor of CharsetToolkit using the charset discovered by the method guessEncoding(). a BufferedReader
throws:
  FileNotFoundException - if the file is not found.



hasUTF16BEBom
public boolean hasUTF16BEBom()(Code)
Has a Byte Order Marker for UTF-16 Big Endian (utf-16 and ucs-2). true if the buffer has a BOM for UTF-16 Big Endian.



hasUTF16LEBom
public boolean hasUTF16LEBom()(Code)
Has a Byte Order Marker for UTF-16 Low Endian (ucs-2le, ucs-4le, and ucs-16le). true if the buffer has a BOM for UTF-16 Low Endian.



hasUTF8Bom
public boolean hasUTF8Bom()(Code)
Has a Byte Order Marker for UTF-8 (Used by Microsoft's Notepad and other editors). true if the buffer has a BOM for UTF8.



setDefaultCharset
public void setDefaultCharset(Charset defaultCharset)(Code)
Defines the default Charset used in case the buffer represents an 8-bit Charset.
Parameters:
  defaultCharset - the default Charset to be returned by guessEncoding()if an 8-bit Charset is encountered.



setEnforce8Bit
public void setEnforce8Bit(boolean enforce)(Code)
If US-ASCII is recognized, enforce to return the default encoding, rather than US-ASCII. It might be a file without any special character in the range 128-255, but that may be or become a file encoded with the default charset rather than US-ASCII.
Parameters:
  enforce - a boolean specifying the use or not of US-ASCII.



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.