Java Doc for DataInput.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.io.DataInput

All known Subclasses:   java.io.RandomAccessFile,  java.io.DataInputStream,  com.sun.cdc.io.j2me.UniversalInputStream,  com.sun.cdc.io.GeneralBase,  sun.io.RandomAccessROMFile,
DataInput
public interface DataInput (Code)
The DataInput interface provides for reading bytes from a binary stream and reconstructing from them data in any of the Java primitive types. There is also a facility for reconstructing a String from data in Java modified UTF-8 format.

It is generally true of all the reading routines in this interface that if end of file is reached before the desired number of bytes has been read, an EOFException (which is a kind of IOException) is thrown. If any byte cannot be read for any reason other than end of file, an IOException other than EOFException is thrown. In particular, an IOException may be thrown if the input stream has been closed.
version:
   12/17/01 (CLDC 1.1)
See Also:   java.io.DataInputStream
See Also:   java.io.DataOutput
since:
   JDK1.0, CLDC 1.0





Method Summary
 booleanreadBoolean()
     Reads one input byte and returns true if that byte is nonzero, false if that byte is zero.
 bytereadByte()
     Reads and returns one input byte.
 charreadChar()
     Reads an input char and returns the char value. A Unicode char is made up of two bytes. Let a be the first byte read and b be the second byte.
 doublereadDouble()
     Reads eight input bytes and returns a double value.
 floatreadFloat()
     Reads four input bytes and returns a float value.
 voidreadFully(byte b)
     Reads some bytes from an input stream and stores them into the buffer array b.
 voidreadFully(byte b, int off, int len)
     Reads len bytes from an input stream.

This method blocks until one of the following conditions occurs:

  • len bytes of input data are available, in which case a normal return is made.
  • End of file is detected, in which case an EOFException is thrown.
  • An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read.

 intreadInt()
     Reads four input bytes and returns an int value.
 longreadLong()
     Reads eight input bytes and returns a long value.
 shortreadShort()
     Reads two input bytes and returns a short value.
 StringreadUTF()
     Reads in a string that has been encoded using a modified UTF-8 format. The general contract of readUTF is that it reads a representation of a Unicode character string encoded in Java modified UTF-8 format; this string of characters is then returned as a String.

First, two bytes are read and used to construct an unsigned 16-bit integer in exactly the manner of the readUnsignedShort method .

 intreadUnsignedByte()
     Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.
 intreadUnsignedShort()
     Reads two input bytes, zero-extends it to type int, and returns an int value in the range 0 through 65535.
 intskipBytes(int n)
     Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes.



Method Detail
readBoolean
boolean readBoolean() throws IOException(Code)
Reads one input byte and returns true if that byte is nonzero, false if that byte is zero. This method is suitable for reading the byte written by the writeBoolean method of interface DataOutput. the boolean value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.



readByte
byte readByte() throws IOException(Code)
Reads and returns one input byte. The byte is treated as a signed value in the range -128 through 127, inclusive. This method is suitable for reading the byte written by the writeByte method of interface DataOutput. the 8-bit value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.



readChar
char readChar() throws IOException(Code)
Reads an input char and returns the char value. A Unicode char is made up of two bytes. Let a be the first byte read and b be the second byte. The value returned is:

(char)((a << 8) | (b & 0xff))
 
This method is suitable for reading bytes written by the writeChar method of interface DataOutput. the Unicode char read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.



readDouble
double readDouble() throws IOException(Code)
Reads eight input bytes and returns a double value. It does this by first constructing a long value in exactly the manner of the readlong method, then converting this long value to a double in exactly the manner of the method Double.longBitsToDouble. This method is suitable for reading bytes written by the writeDouble method of interface DataOutput. the double value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.
since:
   CLDC 1.1



readFloat
float readFloat() throws IOException(Code)
Reads four input bytes and returns a float value. It does this by first constructing an int value in exactly the manner of the readInt method, then converting this int value to a float in exactly the manner of the method Float.intBitsToFloat. This method is suitable for reading bytes written by the writeFloat method of interface DataOutput. the float value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.
since:
   CLDC 1.1



readFully
void readFully(byte b) throws IOException(Code)
Reads some bytes from an input stream and stores them into the buffer array b. The number of bytes read is equal to the length of b.

This method blocks until one of the following conditions occurs:

  • b.length bytes of input data are available, in which case a normal return is made.
  • End of file is detected, in which case an EOFException is thrown.
  • An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[0], the next one into b[1], and so on. If an exception is thrown from this method, then it may be that some but not all bytes of b have been updated with data from the input stream.
Parameters:
  b - the buffer into which the data is read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.




readFully
void readFully(byte b, int off, int len) throws IOException(Code)
Reads len bytes from an input stream.

This method blocks until one of the following conditions occurs:

  • len bytes of input data are available, in which case a normal return is made.
  • End of file is detected, in which case an EOFException is thrown.
  • An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len.
Parameters:
  b - the buffer into which the data is read.
Parameters:
  off - an int specifying the offset into the data.
Parameters:
  len - an int specifying the number of bytes to read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.




readInt
int readInt() throws IOException(Code)
Reads four input bytes and returns an int value. Let a be the first byte read, b be the second byte, c be the third byte, and d be the fourth byte. The value returned is:

 
 (((a & 0xff) << 24) | ((b & 0xff) << 16) |
  ((c & 0xff) << 8) | (d & 0xff))
 
This method is suitable for reading bytes written by the writeInt method of interface DataOutput. the int value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.



readLong
long readLong() throws IOException(Code)
Reads eight input bytes and returns a long value. Let a be the first byte read, b be the second byte, c be the third byte, d be the fourth byte, e be the fifth byte, f be the sixth byte, g be the seventh byte, and h be the eighth byte. The value returned is:

 
 (((long)(a & 0xff) << 56) |
 ((long)(b & 0xff) << 48) |
 ((long)(c & 0xff) << 40) |
 ((long)(d & 0xff) << 32) |
 ((long)(e & 0xff) << 24) |
 ((long)(f & 0xff) << 16) |
 ((long)(g & 0xff) <<  8) |
 ((long)(h & 0xff)))
 

This method is suitable for reading bytes written by the writeLong method of interface DataOutput. the long value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.




readShort
short readShort() throws IOException(Code)
Reads two input bytes and returns a short value. Let a be the first byte read and b be the second byte. The value returned is:

(short)((a << 8) | (b & 0xff))
 
This method is suitable for reading the bytes written by the writeShort method of interface DataOutput. the 16-bit value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.



readUTF
String readUTF() throws IOException(Code)
Reads in a string that has been encoded using a modified UTF-8 format. The general contract of readUTF is that it reads a representation of a Unicode character string encoded in Java modified UTF-8 format; this string of characters is then returned as a String.

First, two bytes are read and used to construct an unsigned 16-bit integer in exactly the manner of the readUnsignedShort method . This integer value is called the UTF length and specifies the number of additional bytes to be read. These bytes are then converted to characters by considering them in groups. The length of each group is computed from the value of the first byte of the group. The byte following a group, if any, is the first byte of the next group.

If the first byte of a group matches the bit pattern 0xxxxxxx (where x means "may be 0 or 1"), then the group consists of just that byte. The byte is zero-extended to form a character.

If the first byte of a group matches the bit pattern 110xxxxx, then the group consists of that byte a and a second byte b. If there is no byte b (because byte a was the last of the bytes to be read), or if byte b does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:

(char)(((a& 0x1F) << 6) | (b & 0x3F))
 
If the first byte of a group matches the bit pattern 1110xxxx, then the group consists of that byte a and two more bytes b and c. If there is no byte c (because byte a was one of the last two of the bytes to be read), or either byte b or byte c does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:


 (char)(((a & 0x0F) << 12) | ((b & 0x3F) << 6) | (c & 0x3F))
 
If the first byte of a group matches the pattern 1111xxxx or the pattern 10xxxxxx, then a UTFDataFormatException is thrown.

If end of file is encountered at any time during this entire process, then an EOFException is thrown.

After every group has been converted to a character by this process, the characters are gathered, in the same order in which their corresponding groups were read from the input stream, to form a String, which is returned.

The writeUTF method of interface DataOutput may be used to write data that is suitable for reading by this method. a Unicode string.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.
exception:
  UTFDataFormatException - if the bytes do not represent avalid UTF-8 encoding of a string.




readUnsignedByte
int readUnsignedByte() throws IOException(Code)
Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. This method is suitable for reading the byte written by the writeByte method of interface DataOutput if the argument to writeByte was intended to be a value in the range 0 through 255. the unsigned 8-bit value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.



readUnsignedShort
int readUnsignedShort() throws IOException(Code)
Reads two input bytes, zero-extends it to type int, and returns an int value in the range 0 through 65535. Let a be the first byte read and b be the second byte. The value returned is:

(((a & 0xff) << 8) | (b & 0xff))
 
This method is suitable for reading the bytes written by the writeShort method of interface DataOutput if the argument to writeShort was intended to be a value in the range 0 through 65535. the unsigned 16-bit value read.
exception:
  EOFException - if this stream reaches the endbefore reading all the bytes.
exception:
  IOException - if an I/O error occurs.



skipBytes
int skipBytes(int n) throws IOException(Code)
Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes. However, it may skip over some smaller number of bytes, possibly zero. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. This method never throws an EOFException. The actual number of bytes skipped is returned.
Parameters:
  n - the number of bytes to be skipped. the actual number of bytes skipped.
exception:
  IOException - if an I/O error occurs.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.