Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.errors 
EOFError 
Packageflash.errors
Classpublic dynamic class EOFError
InheritanceEOFError Inheritance IOError Inheritance Error Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0 Flash Player 9, Flash Lite 4

An EOFError exception is thrown when you attempt to read past the end of the available data. For example, an EOFError is thrown when one of the read methods in the IDataInput interface is called and there is insufficient data to satisfy the read request.

View the examples

See also



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritederrorID : int
[read-only] Contains the reference number associated with the specific error message.
Error
 Inheritedmessage : String
Contains the message associated with the Error object.
Error
 Inheritedname : String
Contains the name of the Error object.
Error
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
EOFError(message:String = "")
Creates a new EOFError object.
EOFError
 Inherited
Returns the call stack for an error as a string at the time of the error's construction (for the debugger version of Flash Player and the AIR Debug Launcher (ADL) only; returns null if not using the debugger version of Flash Player or the ADL.
Error
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns the string "Error" by default or the value contained in the Error.message property, if defined.
Error
 Inherited
Returns the primitive value of the specified object.
Object
Constructor Detail

EOFError

()Constructor
public function EOFError(message:String = "")

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0 Flash Player 9

Creates a new EOFError object.

Parameters
message:String (default = "") — A string associated with the error object.
EOFErrorExample.as

The following example uses the EOFErrorExample class to show the error generated if an attempt is made to read past the end of the available data. This is accomplished with the following steps:
  1. The constructor creates a ByteArray object byteArr and writes a Boolean value of false into the byte stream using writeBoolean().
  2. The position of byteArr is reset to 0 (start of the data stream).
  3. A single byte is removed from the data stream using readBoolean(). The data stream now contains no data.
  4. Within an error handling code segment set to catch EOFError objects, readBoolean() is called a second time and the EOFError is caught and passed to a trace() statement, which outputs the error message associated with EOFError objects.
package {
    import flash.display.Sprite;
    import flash.errors.EOFError;
    import flash.utils.ByteArray;

    public class EOFErrorExample extends Sprite {        
        public function EOFErrorExample() {
            var byteArr:ByteArray = new ByteArray();

            byteArr.writeBoolean(false);
            trace(byteArr.length);        // 1
            
            byteArr.position = 0;
            try {
                trace(byteArr.readBoolean());    // false
            }
            catch(e:EOFError) {
                trace(e);
            }
            try {
                trace(byteArr.readBoolean());
            } 
            catch(e:EOFError) {
                trace(e);        // EOFError: Error #2030: End of file was encountered.
            }
        }
    }
}