com.whitestein.lsps.lang.doc

Class DocError

java.lang.Object

com.whitestein.lsps.lang.doc.DocError

public class DocError
extends java.lang.Object

Documentation of an error. This class allows to obtain detailed information about an error thrown by a method.

Author:

jsa

Constructor Summary

Constructors

Constructor and Description
DocError(java.lang.String errorName, DocText description) Creates a new error description

Method Summary

Modifier and Type	Method and Description
DocText	getDescription() Gets the description of the error.
java.lang.String	getErrorName() Gets the name of the error this element describes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocError

public DocError(java.lang.String errorName,
                DocText description)

Creates a new error description

Parameters:

errorName - the error name

description - the error description

Method Detail

getErrorName

public java.lang.String getErrorName()

Gets the name of the error this element describes.

Returns:

the error name

getDescription

public DocText getDescription()

Gets the description of the error.

Returns:

the description

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object