Package com.github.oowekyala.ooxml.messages

Class XmlException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.github.oowekyala.ooxml.messages.XmlException

All Implemented Interfaces:

Serializable

public final class XmlException
extends RuntimeException

Generic XML exception wrapper. Can occur during validation or parsing.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable String	kind
private final XmlPosition	position
private final XmlSeverity	severity
private final String	simpleMessage

Constructor Summary

Constructors

Constructor	Description
XmlException(NiceXmlMessageSpec spec, @Nullable String fullMessage)	Create a new exception from the given spec.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getKind()	Returns the message kind.
XmlPosition	getPosition()	Returns the position where the error occurred.
XmlSeverity	getSeverity()	Returns the severity of the message.
String	getSimpleMessage()	Returns the error message, without the surrounding line context.
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Details

position

private final XmlPosition position

simpleMessage

private final String simpleMessage

kind

private final @Nullable String kind

severity

private final XmlSeverity severity

Constructor Details

XmlException

public XmlException(NiceXmlMessageSpec spec,
 @Nullable String fullMessage)

Create a new exception from the given spec.

Parameters:

spec - A non-null spec

fullMessage - Used as the toString(). If null, the spec's NiceXmlMessageSpec.getSimpleMessage() is used.

Throws:

NullPointerException - If the spec is null

Method Details

getSimpleMessage

public String getSimpleMessage()

Returns the error message, without the surrounding line context. Throwable.getMessage() will return a fuller message.

getPosition

public XmlPosition getPosition()

Returns the position where the error occurred. This may be undefined.

getKind

public @Nullable String getKind()

Returns the message kind.

getSeverity

public XmlSeverity getSeverity()

Returns the severity of the message.

toString

public String toString()

Overrides:

toString in class Throwable