Java Doc for FilterInputStream.java in  » 6.0-JDK-Modules » j2me » 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 » 6.0 JDK Modules » j2me » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.InputStream
      java.io.FilterInputStream

All known Subclasses:   sun.net.TelnetInputStream,  sun.net.www.MeteredStream,  java.io.BufferedInputStream,  java.util.zip.InflaterInputStream,  sun.audio.AudioStream,  java.security.DigestInputStream,  java.util.zip.CheckedInputStream,  sun.audio.NativeAudioStream,  java.io.PushbackInputStream,
FilterInputStream
public class FilterInputStream extends InputStream (Code)
A FilterInputStream contains some other input stream, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterInputStream itself simply overrides all methods of InputStream with versions that pass all requests to the contained input stream. Subclasses of FilterInputStream may further override some of these methods and may also provide additional methods and fields.
author:
   Jonathan Payne
version:
   1.23, 02/02/00
since:
   JDK1.0


Field Summary
protected  InputStreamin
     The input stream to be filtered.

Constructor Summary
protected  FilterInputStream(InputStream in)
     Creates a FilterInputStream by assigning the argument in to the field this.in so as to remember it for later use.

Method Summary
public  intavailable()
     Returns the number of bytes that can be read from this input stream without blocking.
public  voidclose()
     Closes this input stream and releases any system resources associated with the stream.
public synchronized  voidmark(int readlimit)
     Marks the current position in this input stream.
public  booleanmarkSupported()
     Tests if this input stream supports the mark and reset methods.
public  intread()
     Reads the next byte of data from this input stream.
public  intread(byte b)
     Reads up to byte.length bytes of data from this input stream into an array of bytes.
public  intread(byte b, int off, int len)
     Reads up to len bytes of data from this input stream into an array of bytes.
public synchronized  voidreset()
     Repositions this stream to the position at the time the mark method was last called on this input stream.
public  longskip(long n)
     Skips over and discards n bytes of data from the input stream.

Field Detail
in
protected InputStream in(Code)
The input stream to be filtered.




Constructor Detail
FilterInputStream
protected FilterInputStream(InputStream in)(Code)
Creates a FilterInputStream by assigning the argument in to the field this.in so as to remember it for later use.
Parameters:
  in - the underlying input stream, or null if this instance is to be created without an underlying stream.




Method Detail
available
public int available() throws IOException(Code)
Returns the number of bytes that can be read from this input stream without blocking.

This method simply performs in.available() and returns the result. the number of bytes that can be read from the input streamwithout blocking.
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterInputStream.in




close
public void close() throws IOException(Code)
Closes this input stream and releases any system resources associated with the stream. This method simply performs in.close().
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterInputStream.in



mark
public synchronized void mark(int readlimit)(Code)
Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

This method simply performs in.mark(readlimit).
Parameters:
  readlimit - the maximum limit of bytes that can be read beforethe mark position becomes invalid.
See Also:   java.io.FilterInputStream.in
See Also:   java.io.FilterInputStream.reset




markSupported
public boolean markSupported()(Code)
Tests if this input stream supports the mark and reset methods. This method simply performs in.markSupported(). true if this stream type supports themark and reset method;false otherwise.
See Also:   java.io.FilterInputStream.in
See Also:   java.io.InputStream.mark(int)
See Also:   java.io.InputStream.reset



read
public int read() throws IOException(Code)
Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

This method simply performs in.read() and returns the result. the next byte of data, or -1 if the end of thestream is reached.
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterInputStream.in




read
public int read(byte b) throws IOException(Code)
Reads up to byte.length bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

This method simply performs the call read(b, 0, b.length) and returns the result. It is important that it does not do in.read(b) instead; certain subclasses of FilterInputStream depend on the implementation strategy actually used.
Parameters:
  b - the buffer into which the data is read. the total number of bytes read into the buffer, or-1 if there is no more data because the end ofthe stream has been reached.
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterInputStream.read(byte[]intint)




read
public int read(byte b, int off, int len) throws IOException(Code)
Reads up to len bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

This method simply performs in.read(b, off, len) and returns the result.
Parameters:
  b - the buffer into which the data is read.
Parameters:
  off - the start offset of the data.
Parameters:
  len - the maximum number of bytes read. the total number of bytes read into the buffer, or-1 if there is no more data because the end ofthe stream has been reached.
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterInputStream.in




reset
public synchronized void reset() throws IOException(Code)
Repositions this stream to the position at the time the mark method was last called on this input stream.

This method simply performs in.reset().

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.
exception:
  IOException - if the stream has not been marked or if themark has been invalidated.
See Also:   java.io.FilterInputStream.in
See Also:   java.io.FilterInputStream.mark(int)




skip
public long skip(long n) throws IOException(Code)
Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

This method simply performs in.skip(n).
Parameters:
  n - the number of bytes to be skipped. the actual number of bytes skipped.
exception:
  IOException - if an I/O error occurs.




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
public boolean equals(Object obj)(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.