uk.ac.ed.ph.snuggletex.utilities

类 MessageFormatter

java.lang.Object

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

public final class MessageFormatter
extends java.lang.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

字段概要

字段

限定符和类型	字段和说明
static java.util.PropertyResourceBundle	GENERAL_MESSAGE_BUNDLE ResourceBundle providing templates for message bodies

构造器概要

构造器

构造器和说明
MessageFormatter()

方法概要

限定符和类型	方法和说明
static void	appendErrorAsString(java.lang.StringBuffer messageBuilder, InputError error)
static void	appendSliceContext(java.lang.StringBuffer messageBuilder, FrozenSlice slice)
static java.lang.String	formatErrorAsString(InputError error) Creates a full diagnosis of the given error
static org.w3c.dom.Element	formatErrorAsXHTML(org.w3c.dom.Document ownerDocument, InputError error)
static org.w3c.dom.Element	formatErrorAsXML(org.w3c.dom.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 org.w3c.dom.Element	formatErrorAsXML(org.w3c.dom.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 java.lang.String	formatErrorCodeName(ErrorCode errorCode)
static java.lang.String	formatErrorGroup(ErrorGroup errorGroup)
static java.lang.String	getErrorMessage(ErrorCode errorCode, java.lang.Object... arguments) Constructs an error message for the given ErrorCode and arguments.
static java.lang.String	getErrorMessage(InputError error) Constructs an error message for the given InputError.

从类继承的方法 java.lang.Object

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

字段详细资料

GENERAL_MESSAGE_BUNDLE

public static final java.util.PropertyResourceBundle GENERAL_MESSAGE_BUNDLE

ResourceBundle providing templates for message bodies

构造器详细资料

MessageFormatter

public MessageFormatter()

方法详细资料

getErrorMessage

public static java.lang.String getErrorMessage(InputError error)

Constructs an error message for the given InputError.

getErrorMessage

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

Constructs an error message for the given ErrorCode and arguments.

formatErrorAsString

public static java.lang.String formatErrorAsString(InputError error)

Creates a full diagnosis of the given error

formatErrorGroup

public static java.lang.String formatErrorGroup(ErrorGroup errorGroup)

formatErrorCodeName

public static java.lang.String formatErrorCodeName(ErrorCode errorCode)

formatErrorAsXML

public static org.w3c.dom.Element formatErrorAsXML(org.w3c.dom.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.

参数:

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.

抛出:

org.w3c.dom.DOMException

formatErrorAsXML

public static org.w3c.dom.Element formatErrorAsXML(org.w3c.dom.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.

参数:

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.

抛出:

org.w3c.dom.DOMException

formatErrorAsXHTML

public static org.w3c.dom.Element formatErrorAsXHTML(org.w3c.dom.Document ownerDocument,
                                                     InputError error)

appendErrorAsString

public static void appendErrorAsString(java.lang.StringBuffer messageBuilder,
                                       InputError error)

appendSliceContext

public static void appendSliceContext(java.lang.StringBuffer messageBuilder,
                                      FrozenSlice slice)