| Package | flash.utils |
| Interface | public interface IDataOutput |
| Implementors | ByteArray, FileStream, Socket |
All IDataInput and IDataOutput operations are "bigEndian" by default (the most significant byte in the sequence is stored at the lowest or first storage address), and are nonblocking.
Sign extension matters only when you read data, not when you write it. Therefore, you do not need separate
write methods to work with IDataInput.readUnsignedByte() and
IDataInput.readUnsignedShort(). In other words:
IDataOutput.writeByte() with IDataInput.readUnsignedByte() and
IDataInput.readByte().IDataOutput.writeShort() with IDataInput.readUnsignedShort() and
IDataInput.readShort().See also
| Property | Defined by | ||
|---|---|---|---|
| endian : String
The byte order for the data, either the
BIG_ENDIAN or LITTLE_ENDIAN
constant from the Endian class. | IDataOutput | ||
| objectEncoding : uint
Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the
writeObject() method. | IDataOutput | ||
| Method | Defined by | ||
|---|---|---|---|
|
writeBoolean(value:Boolean):void
Writes a Boolean value.
| IDataOutput | ||
|
Writes a byte.
| IDataOutput | ||
|
Writes a sequence of
length bytes from the
specified byte array, bytes,
starting offset(zero-based index) bytes
into the file stream, byte stream, or byte array. | IDataOutput | ||
|
writeDouble(value:Number):void
Writes an IEEE 754 double-precision (64-bit) floating point number.
| IDataOutput | ||
|
writeFloat(value:Number):void
Writes an IEEE 754 single-precision (32-bit) floating point number.
| IDataOutput | ||
|
Writes a 32-bit signed integer.
| IDataOutput | ||
|
Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
| IDataOutput | ||
|
writeObject(object:*):void
Writes an object to the file stream, byte stream, or byte array, in AMF serialized
format.
| IDataOutput | ||
|
writeShort(value:int):void
Writes a 16-bit integer.
| IDataOutput | ||
|
writeUnsignedInt(value:uint):void
Writes a 32-bit unsigned integer.
| IDataOutput | ||
|
Writes a UTF-8 string to the file stream, byte stream, or byte array.
| IDataOutput | ||
|
writeUTFBytes(value:String):void
Writes a UTF-8 string.
| IDataOutput | ||
| endian | property |
endian:String [read-write]
The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN
constant from the Endian class.
public function get endian():String
public function set endian(value:String):void
See also
| objectEncoding | property |
objectEncoding:uint [read-write]
Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the
writeObject() method. The value is a constant from the ObjectEncoding class.
public function get objectEncoding():uint
public function set objectEncoding(value:uint):void
See also
| writeBoolean | () | method |
public function writeBoolean(value:Boolean):void
Writes a Boolean value. A single byte is written according to the value parameter,
either 1 if true or 0 if false.
value:Boolean — A Boolean value determining which byte is written. If the parameter is true
Flash Player writes a 1; if false, Flash Player writes a 0.
|
| writeByte | () | method |
public function writeByte(value:int):voidWrites a byte. The low 8 bits of the parameter are used. The high 24 bits are ignored.
Parametersvalue:int — A byte value as an integer.
|
| writeBytes | () | method |
public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void
Writes a sequence of length bytes from the
specified byte array, bytes,
starting offset(zero-based index) bytes
into the file stream, byte stream, or byte array.
If the length parameter is omitted, the default
length of 0 is used; Flash Player writes the entire buffer starting at
offset.
If the offset parameter is also omitted, the entire buffer is
written.
If the offset or length parameter
is out of range, they are clamped to the beginning and end
of the bytes array.
bytes:ByteArray — The byte array to write.
|
|
offset:uint (default = 0) — A zero-based index indicating the position into the array to begin writing.
|
|
length:uint (default = 0) — An unsigned integer indicating how far into the buffer to write.
|
| writeDouble | () | method |
public function writeDouble(value:Number):voidWrites an IEEE 754 double-precision (64-bit) floating point number.
Parametersvalue:Number — A double-precision (64-bit) floating point number.
|
| writeFloat | () | method |
public function writeFloat(value:Number):voidWrites an IEEE 754 single-precision (32-bit) floating point number.
Parametersvalue:Number — A single-precision (32-bit) floating point number.
|
| writeInt | () | method |
public function writeInt(value:int):voidWrites a 32-bit signed integer.
Parametersvalue:int — A byte value as a signed integer.
|
| writeMultiByte | () | method |
public function writeMultiByte(value:String, charSet:String):voidWrites a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
Parametersvalue:String — The string value to be written.
|
|
charSet:String — The string denoting the character set to use. Possible character set strings
include "shift-jis", "cn-gb", "iso-8859-1" and others.
For a complete list, see Supported Character Sets.
|
| writeObject | () | method |
public function writeObject(object:*):voidWrites an object to the file stream, byte stream, or byte array, in AMF serialized format.
Parametersobject:* — the object to be serialized
|
See also
| writeShort | () | method |
public function writeShort(value:int):voidWrites a 16-bit integer. The low 16 bits of the parameter are used. The high 16 bits are ignored.
Parametersvalue:int — A byte value as an integer.
|
| writeUnsignedInt | () | method |
public function writeUnsignedInt(value:uint):voidWrites a 32-bit unsigned integer.
Parametersvalue:uint — A byte value as an unsigned integer.
|
| writeUTF | () | method |
public function writeUTF(value:String):voidWrites a UTF-8 string to the file stream, byte stream, or byte array. The length of the UTF-8 string in bytes is written first, as a 16-bit integer, followed by the bytes representing the characters of the string.
Parametersvalue:String — The string value to be written.
|
RangeError — If the length is larger than
65535.
|
| writeUTFBytes | () | method |
public function writeUTFBytes(value:String):void
Writes a UTF-8 string. Similar to writeUTF(),
but does not prefix the string with a 16-bit length word.
value:String — The string value to be written.
|
DataOutputExample to write a boolean
and the double-precision floating-point representation of pi to a byte array. This is accomplished
using the following steps:
byteArr.false and the double-precision
floating-point equivalent of the mathematical value of pi.Notice how a code segment is added at the end to check for end of file errors to ensure that the byte stream is not read past its end.
package {
import flash.display.Sprite;
import flash.utils.ByteArray;
import flash.errors.EOFError;
public class DataOutputExample extends Sprite {
public function DataOutputExample() {
var byteArr:ByteArray = new ByteArray();
byteArr.writeBoolean(false);
byteArr.writeDouble(Math.PI);
byteArr.position = 0;
try {
trace(byteArr.readBoolean()); // false
}
catch(e:EOFError) {
trace(e); // EOFError: Error #2030: End of file was encountered.
}
try {
trace(byteArr.readDouble()); // 3.141592653589793
}
catch(e:EOFError) {
trace(e); // EOFError: Error #2030: End of file was encountered.
}
try {
trace(byteArr.readDouble());
}
catch(e:EOFError) {
trace(e); // EOFError: Error #2030: End of file was encountered.
}
}
}
}
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/apollo/1.0/aslr/flash/utils/IDataOutput.html