com.glaivestone.javax.io
Class FileSystemOperationResult

java.lang.Object
  |
  +--com.glaivestone.javax.util.StatusValue
        |
        +--com.glaivestone.javax.io.FileSystemOperationResult

public class FileSystemOperationResult

extends StatusValue

A status result for operations which involve multiple file system elements.

Author:

Deb Lewis

Field Summary

Fields inherited from class com.glaivestone.javax.util.StatusValue

FAILED, PARTIALLY_SUCCEEDED, SUCCEEDED, SUCCESS_RESULT

Constructor Summary

FileSystemOperationResult()
Create a new operation result status.

Method Summary

int	getNumberOfAffectedElements() Answer the number of file system elements successfully handled by the operation,
int	getNumberOfProblems() Answer the number of file system elements which had problems during the operation,
java.util.List	getProblems() Answer a list containing the problem reports from the operation.
int	getStatusCode() Answer the status code.
void	reportProblem(java.io.File aFileSystemElement, java.lang.Throwable ex) Report a problem processing a file system element
void	reportSuccess(java.io.File aFileSystemElement) Report successful processing of a file system element

Methods inherited from class com.glaivestone.javax.util.StatusValue

failed, getMessage, setMessage, succeeded, succeededCompletely, succeededPartially

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemOperationResult

public FileSystemOperationResult()

Create a new operation result status.

Method Detail

getNumberOfAffectedElements

public int getNumberOfAffectedElements()

Answer the number of file system elements successfully handled by the operation,

getNumberOfProblems

public int getNumberOfProblems()

Answer the number of file system elements which had problems during the operation,

getProblems

public java.util.List getProblems()

Answer a list containing the problem reports from the operation. Returns null if the operation was completely successful

reportProblem

public void reportProblem(java.io.File aFileSystemElement,
                          java.lang.Throwable ex)

Report a problem processing a file system element

getStatusCode

public int getStatusCode()

Answer the status code.

Overrides:

getStatusCode in class StatusValue

reportSuccess

public void reportSuccess(java.io.File aFileSystemElement)

Report successful processing of a file system element