Java Doc for InputStream.java in  » Apache-Harmony-Java-SE » java-package » java » 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 » Apache Harmony Java SE » java package » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.InputStream

InputStream
abstract public class InputStream extends Object implements Closeable(Code)
InputStream is an abstract class for all byte input streams. It provides basic method implementations for reading bytes from a stream.
See Also:   OutputStream



Constructor Summary
public  InputStream()
     This constructor does nothing interesting.

Method Summary
public  intavailable()
     Answers a int representing then number of bytes that are available before this InputStream will block.
public  voidclose()
     Close the InputStream.
public  voidmark(int readlimit)
     Set a Mark position in this InputStream.
public  booleanmarkSupported()
     Answers a boolean indicating whether or not this InputStream supports mark() and reset().
abstract public  intread()
     Reads a single byte from this InputStream and returns the result as an int.
public  intread(byte b)
     Reads bytes from the Stream and stores them in byte array b. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered.
Parameters:
  b - the byte array in which to store the read bytes.
public  intread(byte b, int offset, int length)
     Reads at most length bytes from the Stream and stores them in byte array b starting at offset.
public synchronized  voidreset()
     Reset this InputStream to the last marked location.
public  longskip(long n)
     Skips n number of bytes in this InputStream.


Constructor Detail
InputStream
public InputStream()(Code)
This constructor does nothing interesting. Provided for signature compatibility.




Method Detail
available
public int available() throws IOException(Code)
Answers a int representing then number of bytes that are available before this InputStream will block. This method always returns 0. Subclasses should override and indicate the correct number of bytes available. the number of bytes available before blocking.
throws:
  IOException - If an error occurs in this InputStream.



close
public void close() throws IOException(Code)
Close the InputStream. Concrete implementations of this class should free any resources during close. This implementation does nothing.
throws:
  IOException - If an error occurs attempting to close this InputStream.



mark
public void mark(int readlimit)(Code)
Set a Mark position in this InputStream. The parameter readLimit indicates how many bytes can be read before a mark is invalidated. Sending reset() will reposition the Stream back to the marked position provided readLimit has not been surpassed.

This default implementation does nothing and concrete subclasses must provide their own implementations.
Parameters:
  readlimit - the number of bytes to be able to read before invalidating themark.




markSupported
public boolean markSupported()(Code)
Answers a boolean indicating whether or not this InputStream supports mark() and reset(). This class provides a default implementation which answers false. true if mark() and reset() are supported,false otherwise.



read
abstract public int read() throws IOException(Code)
Reads a single byte from this InputStream and returns the result as an int. The low-order byte is returned or -1 of the end of stream was encountered. This abstract implementation must be provided by concrete subclasses. the byte read or -1 if end of stream.
throws:
  IOException - If the stream is already closed or another IOExceptionoccurs.



read
public int read(byte b) throws IOException(Code)
Reads bytes from the Stream and stores them in byte array b. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered.
Parameters:
  b - the byte array in which to store the read bytes. the number of bytes actually read or -1 if end of stream.
throws:
  IOException - If the stream is already closed or another IOExceptionoccurs.



read
public int read(byte b, int offset, int length) throws IOException(Code)
Reads at most length bytes from the Stream and stores them in byte array b starting at offset. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered.
Parameters:
  b - the byte array in which to store the read bytes.
Parameters:
  offset - the offset in b to store the read bytes.
Parameters:
  length - the maximum number of bytes to store in b. the number of bytes actually read or -1 if end of stream.
throws:
  IOException - If the stream is already closed or another IOExceptionoccurs.



reset
public synchronized void reset() throws IOException(Code)
Reset this InputStream to the last marked location. If the readlimit has been passed or no mark has been set, throw IOException. This implementation throws IOException and concrete subclasses should provide proper implementations.
throws:
  IOException - If the stream is already closed or another IOExceptionoccurs.



skip
public long skip(long n) throws IOException(Code)
Skips n number of bytes in this InputStream. Subsequent read()'s will not return these bytes unless reset() is used. This method may perform multiple reads to read n bytes. This default implementation reads n bytes into a temporary buffer. Concrete subclasses should provide their own implementation.
Parameters:
  n - the number of bytes to skip. the number of bytes actually skipped.
throws:
  IOException - If the stream is already closed or another IOExceptionoccurs.



Methods inherited from java.lang.Object
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object object)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final public Class<? extends Object> getClass()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
final public void notify()(Code)(Java Doc)
final public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final public void wait(long millis, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait(long millis) 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.