Java Doc for InputStreamReader.java in  » 6.0-JDK-Core » io-nio » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
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
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » io nio » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.Reader
      java.io.InputStreamReader

All known Subclasses:   java.io.FileReader,
InputStreamReader
public class InputStreamReader extends Reader (Code)
An InputStreamReader is a bridge from byte streams to character streams: It reads bytes and decodes them into characters using a specified java.nio.charset.Charset charset . The charset that it uses may be specified by name or may be given explicitly, or the platform's default charset may be accepted.

Each invocation of one of an InputStreamReader's read() methods may cause one or more bytes to be read from the underlying byte-input stream. To enable the efficient conversion of bytes to characters, more bytes may be read ahead from the underlying stream than are necessary to satisfy the current read operation.

For top efficiency, consider wrapping an InputStreamReader within a BufferedReader. For example:

 BufferedReader in
 = new BufferedReader(new InputStreamReader(System.in));
 

See Also:   BufferedReader
See Also:   InputStream
See Also:   java.nio.charset.Charset
version:
   1.53, 07/05/05
author:
   Mark Reinhold
since:
   JDK1.1



Constructor Summary
public  InputStreamReader(InputStream in)
     Creates an InputStreamReader that uses the default charset.
public  InputStreamReader(InputStream in, String charsetName)
     Creates an InputStreamReader that uses the named charset.
public  InputStreamReader(InputStream in, Charset cs)
     Creates an InputStreamReader that uses the given charset.
public  InputStreamReader(InputStream in, CharsetDecoder dec)
     Creates an InputStreamReader that uses the given charset decoder.

Method Summary
public  voidclose()
    
public  StringgetEncoding()
     Returns the name of the character encoding being used by this stream.

If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.

If this instance was created with the InputStreamReader.InputStreamReader(InputStream,String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor.

public  intread()
     Reads a single character.
public  intread(char cbuf, int offset, int length)
     Reads characters into a portion of an array.
public  booleanready()
     Tells whether this stream is ready to be read.


Constructor Detail
InputStreamReader
public InputStreamReader(InputStream in)(Code)
Creates an InputStreamReader that uses the default charset.
Parameters:
  in - An InputStream



InputStreamReader
public InputStreamReader(InputStream in, String charsetName) throws UnsupportedEncodingException(Code)
Creates an InputStreamReader that uses the named charset.
Parameters:
  in - An InputStream
Parameters:
  charsetName - The name of a supportedjava.nio.charset.Charset charset
exception:
  UnsupportedEncodingException - If the named charset is not supported



InputStreamReader
public InputStreamReader(InputStream in, Charset cs)(Code)
Creates an InputStreamReader that uses the given charset.


Parameters:
  in - An InputStream
Parameters:
  cs - A charset
since:
   1.4



InputStreamReader
public InputStreamReader(InputStream in, CharsetDecoder dec)(Code)
Creates an InputStreamReader that uses the given charset decoder.


Parameters:
  in - An InputStream
Parameters:
  dec - A charset decoder
since:
   1.4




Method Detail
close
public void close() throws IOException(Code)



getEncoding
public String getEncoding()(Code)
Returns the name of the character encoding being used by this stream.

If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.

If this instance was created with the InputStreamReader.InputStreamReader(InputStream,String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method will return null if the stream has been closed.

The historical name of this encoding, ornull if the stream has been closed
See Also:   java.nio.charset.Charset



read
public int read() throws IOException(Code)
Reads a single character. The character read, or -1 if the end of the stream has beenreached
exception:
  IOException - If an I/O error occurs



read
public int read(char cbuf, int offset, int length) throws IOException(Code)
Reads characters into a portion of an array.
Parameters:
  cbuf - Destination buffer
Parameters:
  offset - Offset at which to start storing characters
Parameters:
  length - Maximum number of characters to read The number of characters read, or -1 if the end of the stream has been reached
exception:
  IOException - If an I/O error occurs



ready
public boolean ready() throws IOException(Code)
Tells whether this stream is ready to be read. An InputStreamReader is ready if its input buffer is not empty, or if bytes are available to be read from the underlying byte stream.
exception:
  IOException - If an I/O error occurs



Fields inherited from java.io.Reader
protected Object lock(Code)(Java Doc)

Methods inherited from java.io.Reader
abstract public void close() throws IOException(Code)(Java Doc)
public void mark(int readAheadLimit) throws IOException(Code)(Java Doc)
public boolean markSupported()(Code)(Java Doc)
public int read(java.nio.CharBuffer target) throws IOException(Code)(Java Doc)
public int read() throws IOException(Code)(Java Doc)
public int read(char cbuf) throws IOException(Code)(Java Doc)
abstract public int read(char cbuf, int off, int len) throws IOException(Code)(Java Doc)
public boolean ready() throws IOException(Code)(Java Doc)
public 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.