Package com.storedobject.common

Class ErrorText

java.lang.Object

com.storedobject.common.HTMLText

com.storedobject.common.ErrorText

All Implemented Interfaces:

StyledBuilder

Direct Known Subclasses:

TransactionControl

public class ErrorText
extends HTMLText

The ErrorText class extends the HTMLText class and represents a specialized text container capable of handling errors and associating error data.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from interface com.storedobject.common.StyledBuilder

StyledBuilder.Style

Field Summary

Fields inherited from class com.storedobject.common.HTMLText

ALLOW_TOP_LEVEL, value

Fields inherited from interface com.storedobject.common.StyledBuilder

EMPTY_STRINGS

Constructor Summary

Constructors

Constructor	Description
ErrorText()	Default constructor for the ErrorText class.

Method Summary

Modifier and Type	Method	Description
ErrorText	clear()	Clear the content.
Throwable	generateError()	Generates and retrieves an error associated with this instance.
Throwable	getError()	Retrieves the error associated with this instance.
Object	getErrorObject()	Retrieves the error object associated with this instance.
boolean	isError()	Checks whether an error is present in this instance.
void	setError(Throwable error)	Sets the error associated with this instance.
void	setErrorObject(Object errorObject)	Sets the error object associated with this instance.
void	throwError()	Throws a Throwable error associated with this instance, if one is present.

Methods inherited from class com.storedobject.common.HTMLText

append, append, append, append, appendHTML, clearContent, drawLine, encode, getText, isAllowTopLevelHTML, isEmpty, isNewLine, newLine, newLine, setAllowTopLevelHTML, setText, space, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.common.StyledBuilder

setValue, setValue, setValue, update

Constructor Details

ErrorText

public ErrorText()

Default constructor for the ErrorText class. This constructor initializes an instance of ErrorText without any predefined error object or error state.

Method Details

setErrorObject

public void setErrorObject(Object errorObject)

Sets the error object associated with this instance. If an error object is already set, this method will not overwrite it.

Parameters:

errorObject - the error object to be associated with this instance. This can be any object containing error-specific details.

getErrorObject

public Object getErrorObject()

Retrieves the error object associated with this instance. The error object may contain details related to an error and is typically set using the setErrorObject method.

Returns:

the error object associated with this instance, or null if no error object has been set.

setError

public void setError(Throwable error)

Sets the error associated with this instance. This method will only overwrite the existing error if the current error is null or if the new error being set is not null.

Parameters:

error - the Throwable representing the error to be associated with this instance. It can be null to clear the error if no error is currently associated.

getError

public Throwable getError()

Retrieves the error associated with this instance. The returned error is a Throwable that represents the error condition, or null if no error has been set.

Returns:

the Throwable representing the error associated with this instance, or null if no error is present.

isError

public boolean isError()

Checks whether an error is present in this instance.

Returns:

true if an error is associated with this instance, false otherwise.

generateError

public Throwable generateError()

Generates and retrieves an error associated with this instance. If an error is already set, it directly returns that error. If no error is set and the instance is not empty, a new SOException is created using the string representation of this instance. If the instance is empty and no error is set, null is returned.

Returns:

the Throwable representing the current error, a new SOException if one needs to be generated, or null if no error is present and the instance is empty.

throwError

public void throwError()
                throws Throwable

Throws a Throwable error associated with this instance, if one is present. The error is retrieved using the generateError() method. If a Throwable is generated and is not null, it is immediately thrown. If no error is generated or the error is null, the method completes without any action.

Throws:

Throwable - if an error is generated by generateError() and is not null.

clear

public ErrorText clear()

Description copied from class: HTMLText

Clear the content.

Overrides:

clear in class HTMLText

Returns:

Self-reference is returned.