Top Description Fields Constructors Methods
com.google.common.io

public final Class LittleEndianDataOutputStream

extends FilterOutputStream
implements DataOutput
Class Inheritance
All Implemented Interfaces
java.io.DataOutput
Annotations
@J2ktIncompatible
@GwtIncompatible
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtIncompatible, .J2ktIncompatible, com.google.common.base.Preconditions, com.google.common.primitives.Longs, java.io.DataOutput, .DataOutputStream, .FilterOutputStream, .IOException, .OutputStream

An implementation of DataOutput that uses little-endian byte ordering for writing char, short, int, float, double, and long values.

Note

This class intentionally violates the specification of its supertype DataOutput, which explicitly requires big-endian byte order.

Authors
Chris Nokleberg, Keith Bottner
Since
8.0

Field Summary

Inherited from java.io.FilterOutputStream:
out

Constructor Summary

AccessConstructor and Description
public
LittleEndianDataOutputStream(OutputStream
the stream to delegate to
out
)

Creates a LittleEndianDataOutputStream that wraps the given stream.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with the stream.
public void
write(byte[]
the data.
b
,
int
the start offset in the data.
off
,
int
the number of bytes to write.
len
)

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Writes len bytes from array b, in order, to the output stream.
public void
writeBoolean(boolean
the boolean to be written.
v
)

Implements java.io.DataOutput.writeBoolean.

Writes a boolean value to this output stream.
public void
writeByte(int
the byte value to be written.
v
)

Implements java.io.DataOutput.writeByte.

Writes to the output stream the eight low-order bits of the argument v.
public void
writeBytes(String
the string of bytes to be written.
s
)

Implements java.io.DataOutput.writeBytes.

Deprecated The semantics of writeBytes(String s) are considered dangerous.
Writes a string to the output stream.
public void
writeChar(int
the char value to be written.
v
)

Implements java.io.DataOutput.writeChar.

Writes a char as specified by DataOutputStream#writeChar(int), except using little-endian byte order.
public void
writeChars(String
the string value to be written.
s
)

Implements java.io.DataOutput.writeChars.

Writes a String as specified by DataOutputStream#writeChars(String), except each character is written using little-endian byte order.
public void
writeDouble(double
the double value to be written.
v
)

Implements java.io.DataOutput.writeDouble.

Writes a double as specified by DataOutputStream#writeDouble(double), except using little-endian byte order.
public void
writeFloat(float
the float value to be written.
v
)

Implements java.io.DataOutput.writeFloat.

Writes a float as specified by DataOutputStream#writeFloat(float), except using little-endian byte order.
public void
writeInt(int
the int value to be written.
v
)

Implements java.io.DataOutput.writeInt.

Writes an int as specified by DataOutputStream#writeInt(int), except using little-endian byte order.
public void
writeLong(long
the long value to be written.
v
)

Implements java.io.DataOutput.writeLong.

Writes a long as specified by DataOutputStream#writeLong(long), except using little-endian byte order.
public void
writeShort(int
the short value to be written.
v
)

Implements java.io.DataOutput.writeShort.

Writes a short as specified by DataOutputStream#writeShort(int), except using little-endian byte order.
public void
writeUTF(String
the string value to be written.
str
)

Implements java.io.DataOutput.writeUTF.

Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s.
Inherited from java.io.FilterOutputStream:
flushwritewrite

Constructor Detail

LittleEndianDataOutputStreamback to summary
public LittleEndianDataOutputStream(OutputStream out)

Creates a LittleEndianDataOutputStream that wraps the given stream.

Parameters
out:OutputStream

the stream to delegate to

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterOutputStream.close.

Closes this output stream and releases any system resources associated with the stream.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Doc from java.io.DataOutput.write.

Writes len bytes from array b, in order, to the output stream. 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 written. Otherwise, the byte b[off] is written first, then b[off+1], and so on; the last byte written is b[off+len-1].

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeBooleanback to summary
public void writeBoolean(boolean v) throws IOException

Implements java.io.DataOutput.writeBoolean.

Doc from java.io.DataOutput.writeBoolean.

Writes a boolean value to this output stream. If the argument v is true, the value (byte)1 is written; if v is false, the value (byte)0 is written. The byte written by this method may be read by the readBoolean method of interface DataInput, which will then return a boolean equal to v.

Parameters
v:boolean

the boolean to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeByteback to summary
public void writeByte(int v) throws IOException

Implements java.io.DataOutput.writeByte.

Doc from java.io.DataOutput.writeByte.

Writes to the output stream the eight low-order bits of the argument v. The 24 high-order bits of v are ignored. (This means that writeByte does exactly the same thing as write for an integer argument.) The byte written by this method may be read by the readByte method of interface DataInput, which will then return a byte equal to (byte)v.

Parameters
v:int

the byte value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeBytesback to summary
public void writeBytes(String s) throws IOException

Implements java.io.DataOutput.writeBytes.

Doc from java.io.DataOutput.writeBytes.

Deprecated

The semantics of writeBytes(String s) are considered dangerous. Please use writeUTF(String s), writeChars(String s) or another write method instead.

Writes a string to the output stream. For every character in the string s, taken in order, one byte is written to the output stream. If s is null, a NullPointerException is thrown.

If s.length is zero, then no bytes are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1]. For each character, one byte is written, the low-order byte, in exactly the manner of the writeByte method . The high-order eight bits of each character in the string are ignored.

Parameters
s:String

the string of bytes to be written.

Annotations
@Deprecated
@Override
Exceptions
IOException:
if an I/O error occurs.
writeCharback to summary
public void writeChar(int v) throws IOException

Implements java.io.DataOutput.writeChar.

Writes a char as specified by DataOutputStream#writeChar(int), except using little-endian byte order.

Parameters
v:int

Doc from java.io.DataOutput.writeChar.

the char value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeCharsback to summary
public void writeChars(String s) throws IOException

Implements java.io.DataOutput.writeChars.

Writes a String as specified by DataOutputStream#writeChars(String), except each character is written using little-endian byte order.

Parameters
s:String

Doc from java.io.DataOutput.writeChars.

the string value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeDoubleback to summary
public void writeDouble(double v) throws IOException

Implements java.io.DataOutput.writeDouble.

Writes a double as specified by DataOutputStream#writeDouble(double), except using little-endian byte order.

Parameters
v:double

Doc from java.io.DataOutput.writeDouble.

the double value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeFloatback to summary
public void writeFloat(float v) throws IOException

Implements java.io.DataOutput.writeFloat.

Writes a float as specified by DataOutputStream#writeFloat(float), except using little-endian byte order.

Parameters
v:float

Doc from java.io.DataOutput.writeFloat.

the float value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeIntback to summary
public void writeInt(int v) throws IOException

Implements java.io.DataOutput.writeInt.

Writes an int as specified by DataOutputStream#writeInt(int), except using little-endian byte order.

Parameters
v:int

Doc from java.io.DataOutput.writeInt.

the int value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeLongback to summary
public void writeLong(long v) throws IOException

Implements java.io.DataOutput.writeLong.

Writes a long as specified by DataOutputStream#writeLong(long), except using little-endian byte order.

Parameters
v:long

Doc from java.io.DataOutput.writeLong.

the long value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeShortback to summary
public void writeShort(int v) throws IOException

Implements java.io.DataOutput.writeShort.

Writes a short as specified by DataOutputStream#writeShort(int), except using little-endian byte order.

Parameters
v:int

Doc from java.io.DataOutput.writeShort.

the short value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeUTFback to summary
public void writeUTF(String str) throws IOException

Implements java.io.DataOutput.writeUTF.

Doc from java.io.DataOutput.writeUTF.

Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s. If s is null, a NullPointerException is thrown. Each character in the string s is converted to a group of one, two, or three bytes, depending on the value of the character.

If a character c is in the range \u0001 through \u007f, it is represented by one byte:

(byte)c 

If a character c is \u0000 or is in the range \u0080 through \u07ff, then it is represented by two bytes, to be written in the order shown:

(byte)(0xc0 | (0x1f & (c >> 6)))
(byte)(0x80 | (0x3f & c))

If a character c is in the range \u0800 through uffff, then it is represented by three bytes, to be written in the order shown:

(byte)(0xe0 | (0x0f & (c >> 12)))
(byte)(0x80 | (0x3f & (c >>  6)))
(byte)(0x80 | (0x3f & c))

First, the total number of bytes needed to represent all the characters of s is calculated. If this number is larger than 65535, then a UTFDataFormatException is thrown. Otherwise, this length is written to the output stream in exactly the manner of the writeShort method; after this, the one-, two-, or three-byte representation of each character in the string s is written.

The bytes written by this method may be read by the readUTF method of interface DataInput, which will then return a String equal to s.

Parameters
str:String

the string value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.