org.speakright.core
Class SRError

java.lang.Object
  org.speakright.core.SRError

public class SRError
extends java.lang.Object

Manages error tracking. Various SpeakRight classes will have SRError objects to track their own errors. The failed method merges errors into a parent SRError.

Author:

Ian Rae

Constructor Summary

SRError()

SRError(java.lang.String component)

Method Summary

boolean	failed()
boolean	failed(SRError parent) Merges this objects errors with parent.
boolean	failure() Return true if an error has been reported.
void	logError(int errorCode, java.lang.String description) Reports an error.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SRError

public SRError()

SRError

public SRError(java.lang.String component)

Method Detail

logError

public void logError(int errorCode,
                     java.lang.String description)

Reports an error. This is the method used throughout SpeakRight to report errors.

Parameters:

errorCode - ??

description - friendly description

failure

public boolean failure()

Return true if an error has been reported.

Returns:

whether error has been reported.

failed

public boolean failed(SRError parent)

Merges this objects errors with parent.

Parameters:

parent - A SRError object owned by a higher-level object

Returns:

whether errors have occured.

failed

public boolean failed()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object