uk.ac.ed.ph.snuggletex.utilities

Class MessageFormatter

java.lang.Object

uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

public final class MessageFormatter
extends Object

Utility class that formats an InputError in various ways. NOTE: We're using MessageFormat extensively here, which hasn't been updated to use StringBuilder so we'll sadly have to make do with StringBuffer

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyResourceBundle	GENERAL_MESSAGE_BUNDLE ResourceBundle providing templates for message bodies

Constructor Summary

Constructors

Constructor and Description
MessageFormatter()

Method Summary

Modifier and Type	Method and Description
static void	appendErrorAsString(StringBuffer messageBuilder, InputError error)
static void	appendSliceContext(StringBuffer messageBuilder, FrozenSlice slice)
static String	formatErrorAsString(InputError error) Creates a full diagnosis of the given error
static Element	formatErrorAsXHTML(Document ownerDocument, InputError error)
static Element	formatErrorAsXML(Document ownerDocument, DOMOutputOptions options, InputError error, boolean fullDetails) Creates a DOM Element containing information about the given error, including either just the ErrorCode or full details.
static Element	formatErrorAsXML(Document ownerDocument, InputError error, boolean fullDetails) Creates a DOM Element containing information about the given error, including either just the ErrorCode or full details.
static String	formatErrorCodeName(ErrorCode errorCode)
static String	formatErrorGroup(ErrorGroup errorGroup)
static String	getErrorMessage(ErrorCode errorCode, Object... arguments) Constructs an error message for the given ErrorCode and arguments.
static String	getErrorMessage(InputError error) Constructs an error message for the given InputError.

Methods inherited from class java.lang.Object

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

Field Detail

GENERAL_MESSAGE_BUNDLE

public static final PropertyResourceBundle GENERAL_MESSAGE_BUNDLE

ResourceBundle providing templates for message bodies

Constructor Detail

MessageFormatter

public MessageFormatter()

Method Detail

getErrorMessage

public static String getErrorMessage(InputError error)

Constructs an error message for the given InputError.

getErrorMessage

public static String getErrorMessage(ErrorCode errorCode,
                                     Object... arguments)

Constructs an error message for the given ErrorCode and arguments.

formatErrorAsString

public static String formatErrorAsString(InputError error)

Creates a full diagnosis of the given error

formatErrorGroup

public static String formatErrorGroup(ErrorGroup errorGroup)

formatErrorCodeName

public static String formatErrorCodeName(ErrorCode errorCode)

formatErrorAsXML

public static Element formatErrorAsXML(Document ownerDocument,
                                       InputError error,
                                       boolean fullDetails)

Creates a DOM Element containing information about the given error, including either just the ErrorCode or full details.

The error Element will have qualified name error and belong to the SnuggleConstants.SNUGGLETEX_NAMESPACE namespace.

Parameters:

ownerDocument - Document that will contain the resulting element.

error - InputError to format

fullDetails - false if you just want the error code, true for full details.

Throws:

DOMException

formatErrorAsXML

public static Element formatErrorAsXML(Document ownerDocument,
                                       DOMOutputOptions options,
                                       InputError error,
                                       boolean fullDetails)

Creates a DOM Element containing information about the given error, including either just the ErrorCode or full details.

The error Element will have the given qualified name and namespace as determined by the DOMOutputOptions passed.

Parameters:

ownerDocument - Document that will contain the resulting element.

error - InputError to format

fullDetails - false if you just want the error code, true for full details.

Throws:

DOMException

formatErrorAsXHTML

public static Element formatErrorAsXHTML(Document ownerDocument,
                                         InputError error)

appendErrorAsString

public static void appendErrorAsString(StringBuffer messageBuilder,
                                       InputError error)

appendSliceContext

public static void appendSliceContext(StringBuffer messageBuilder,
                                      FrozenSlice slice)