org.wisepersist.gwt.uploader.client.events

Class FileQueueErrorEvent

java.lang.Object

org.wisepersist.gwt.uploader.client.events.FileQueueErrorEvent

public class FileQueueErrorEvent
extends java.lang.Object

Provides access to the raw information provided by Uploader when a 'fileQueueError' event occurs. This class should not be instantiated directly, but instead you should create a FileQueueErrorHandler and register it via the .Uploader#setFileQueueErrorHandler(FileQueueErrorHandler) method in order to access file queue error events.

Note that the 'fileQueueError' event is fired for each file that was not queued after the File Selection Dialog window is closed. A file may not be queued for several reasons such as, the file exceeds the file size, the file is empty or a file or queue limit has been exceeded.

The reason for the queue error is specified by the getErrorCode() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileQueueErrorEvent.ErrorCode An enumeration of reported file queue error code types.

Constructor Summary

Constructors

Constructor and Description
FileQueueErrorEvent(File file, int errorCode, java.lang.String message) This constructor is intended for internal use only.

Method Summary

Modifier and Type	Method and Description
FileQueueErrorEvent.ErrorCode	getErrorCode() The error code returned by the Uploader component in the case of a file queu failure, conveniently converted to an enumeration type.
int	getErrorCodeAsInt() The original numeric error code returned by the Uploader component in the case of a file queue failure.
File	getFile() Return the details of the file that experienced the error in the queue.
java.lang.String	getMessage() Return a human readable error message explaining the cause of the file queue failure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileQueueErrorEvent

public FileQueueErrorEvent(File file,
                           int errorCode,
                           java.lang.String message)

This constructor is intended for internal use only. You should not create file queued events directly, but instead should register a FileQueuedHandler.

Parameters:

file - The file instance that experienced an error in the queue.

errorCode - The error code returned by the Uploader component in the case of a file queue failure.

message - A human readable error message explaining the cause of the file queue failure.

Method Detail

getFile

public File getFile()

Return the details of the file that experienced the error in the queue.

Returns:

File

getErrorCode

public FileQueueErrorEvent.ErrorCode getErrorCode()

The error code returned by the Uploader component in the case of a file queu failure, conveniently converted to an enumeration type.

Returns:

ErrorCode

getErrorCodeAsInt

public int getErrorCodeAsInt()

The original numeric error code returned by the Uploader component in the case of a file queue failure.

Returns:

int

getMessage

public java.lang.String getMessage()

Return a human readable error message explaining the cause of the file queue failure.

Returns:

String