Java Doc for UnicodeInputStream.java in  » Template-Engine » Velocity » org » apache » velocity » io » 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 » Template Engine » Velocity » org.apache.velocity.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.InputStream
      org.apache.velocity.io.UnicodeInputStream

UnicodeInputStream
public class UnicodeInputStream extends InputStream (Code)
This is an input stream that is unicode BOM aware. This allows you to e.g. read Windows Notepad Unicode files as Velocity templates. It allows you to check the actual encoding of a file by calling UnicodeInputStream.getEncodingFromStream() on the input stream reader. This class is not thread safe! When more than one thread wants to use an instance of UnicodeInputStream, the caller must provide synchronization.
author:
   Aki Nieminen
author:
   Henning P. Schmiedehausen
version:
   $Id: UnicodeInputStream.java 500638 2007-01-27 22:16:10Z henning $

Inner Class :final static class UnicodeBOM

Field Summary
final public static  UnicodeBOMUTF16BE_BOM
     BOM Marker for UTF 16, big endian.
final public static  UnicodeBOMUTF16LE_BOM
     BOM Marker for UTF 16, little endian.
final public static  UnicodeBOMUTF32BE_BOM
     BOM Marker for UTF 32, big endian.
final public static  UnicodeBOMUTF32LE_BOM
     BOM Marker for UTF 32, little endian.
final public static  UnicodeBOMUTF8_BOM
     BOM Marker for UTF 8.

Constructor Summary
public  UnicodeInputStream(InputStream inputStream)
     Creates a new UnicodeInputStream object.
public  UnicodeInputStream(InputStream inputStream, boolean skipBOM)
     Creates a new UnicodeInputStream object.
Parameters:
  inputStream - The input stream to use for reading.
Parameters:
  skipBOM - If this is set to true, a BOM read from the stream is discarded.

Method Summary
public  intavailable()
    
public  voidclose()
    
public  StringgetEncodingFromStream()
     Read encoding based on BOM.
public  booleanisSkipBOM()
     Returns true if the input stream discards the BOM.
public  voidmark(int readlimit)
    
public  booleanmarkSupported()
    
public  intread()
    
public  intread(byte[] b)
    
public  intread(byte[] b, int off, int len)
    
protected  StringreadEncoding()
     This method gets the encoding from the stream contents if a BOM exists.
public  voidreset()
    
public  longskip(long n)
    

Field Detail
UTF16BE_BOM
final public static UnicodeBOM UTF16BE_BOM(Code)
BOM Marker for UTF 16, big endian. See http://www.unicode.org/unicode/faq/utf_bom.html



UTF16LE_BOM
final public static UnicodeBOM UTF16LE_BOM(Code)
BOM Marker for UTF 16, little endian. See http://www.unicode.org/unicode/faq/utf_bom.html



UTF32BE_BOM
final public static UnicodeBOM UTF32BE_BOM(Code)
BOM Marker for UTF 32, big endian. See http://www.unicode.org/unicode/faq/utf_bom.html TODO: Does Java actually support this?



UTF32LE_BOM
final public static UnicodeBOM UTF32LE_BOM(Code)
BOM Marker for UTF 32, little endian. See http://www.unicode.org/unicode/faq/utf_bom.html TODO: Does Java actually support this?



UTF8_BOM
final public static UnicodeBOM UTF8_BOM(Code)
BOM Marker for UTF 8. See http://www.unicode.org/unicode/faq/utf_bom.html




Constructor Detail
UnicodeInputStream
public UnicodeInputStream(InputStream inputStream) throws IllegalStateException, IOException(Code)
Creates a new UnicodeInputStream object. Skips a BOM which defines the file encoding.
Parameters:
  inputStream - The input stream to use for reading.



UnicodeInputStream
public UnicodeInputStream(InputStream inputStream, boolean skipBOM) throws IllegalStateException, IOException(Code)
Creates a new UnicodeInputStream object.
Parameters:
  inputStream - The input stream to use for reading.
Parameters:
  skipBOM - If this is set to true, a BOM read from the stream is discarded. This parameter should normally be true.




Method Detail
available
public int available() throws IOException(Code)

See Also:   java.io.InputStream.available



close
public void close() throws IOException(Code)

See Also:   java.io.InputStream.close



getEncodingFromStream
public String getEncodingFromStream()(Code)
Read encoding based on BOM. The encoding based on the BOM.
throws:
  IllegalStateException - When a problem reading the BOM occured.



isSkipBOM
public boolean isSkipBOM()(Code)
Returns true if the input stream discards the BOM. True if the input stream discards the BOM.



mark
public void mark(int readlimit)(Code)

See Also:   java.io.InputStream.mark(int)



markSupported
public boolean markSupported()(Code)

See Also:   java.io.InputStream.markSupported



read
public int read() throws IOException(Code)

See Also:   java.io.InputStream.read



read
public int read(byte[] b) throws IOException(Code)

See Also:   java.io.InputStream.read(byte[])



read
public int read(byte[] b, int off, int len) throws IOException(Code)

See Also:   java.io.InputStream.read(byte[]intint)



readEncoding
protected String readEncoding() throws IOException(Code)
This method gets the encoding from the stream contents if a BOM exists. If no BOM exists, the encoding is undefined. The encoding of this streams contents as decided by the BOM or null if no BOM was found.



reset
public void reset() throws IOException(Code)

See Also:   java.io.InputStream.reset



skip
public long skip(long n) throws IOException(Code)

See Also:   java.io.InputStream.skip(long)



Methods inherited from java.io.InputStream
public int available() throws IOException(Code)(Java Doc)
public void close() throws IOException(Code)(Java Doc)
public synchronized void mark(int readlimit)(Code)(Java Doc)
public boolean markSupported()(Code)(Java Doc)
abstract public int read() throws IOException(Code)(Java Doc)
public int read(byte b) throws IOException(Code)(Java Doc)
public int read(byte b, int off, int len) throws IOException(Code)(Java Doc)
public synchronized void reset() throws IOException(Code)(Java Doc)
public long skip(long n) throws IOException(Code)(Java Doc)

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.