public class XmlError extends Object implements Serializable
The message can be an error, warning, or simple information, and it may optionally be associated with a specific location in an XML document. The class includes methods for extracting the location as a line number, XmlCursor, or XmlObject, as well as for obtaining and message and severity of the error.
Modifier and Type | Field and Description |
---|---|
static int |
SEVERITY_ERROR
An error.
|
static int |
SEVERITY_INFO
An informational message.
|
static int |
SEVERITY_WARNING
A warning.
|
Constructor and Description |
---|
XmlError(XmlError src)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
static XmlError |
forCursor(String message,
int severity,
XmlCursor cursor)
Returns an XmlError for the given message, with the given severity, located at the XmlCursor.
|
static XmlError |
forCursor(String code,
Object[] args,
int severity,
XmlCursor cursor)
Returns an XmlError for the given message, with the given severity, located at the XmlCursor.
|
static XmlError |
forCursor(String code,
Object[] args,
XmlCursor cursor)
Returns an XmlError for the given message, located at the XmlCursor, with
SEVERITY_ERROR . |
static XmlError |
forCursor(String message,
XmlCursor cursor)
Returns an XmlError for the given message, located at the XmlCursor, with
SEVERITY_ERROR . |
static XmlError |
forLocation(String message,
int severity,
String sourceName,
int line,
int column,
int offset)
Returns an XmlError for the given message, with the given severity, located at a specific point in the given file.
|
static XmlError |
forLocation(String code,
Object[] args,
int severity,
String sourceName,
int line,
int column,
int offset)
Returns an XmlError for the given message, with the given severity, located at a specific point in the given file.
|
static XmlError |
forLocation(String message,
String sourceName,
int line,
int column,
int offset)
Returns an XmlError for the given message, located at a specific point in the given file and
SEVERITY_ERROR . |
static XmlError |
forLocation(String message,
String sourceName,
Location location)
Returns an XmlError for the given message, located at a specific point in the given file and
SEVERITY_ERROR . |
static XmlError |
forLocationAndCursor(String message,
int severity,
String sourceName,
int line,
int column,
int offset,
XmlCursor cursor)
Returns an XmlError for the given message, with the given severity, located at the given physcial location and XmlCursor.
|
static String |
formattedMessage(String code,
Object[] args)
Tries to format a message using the error code.
|
static XmlError |
forMessage(String message)
Returns an XmlError for the given message, with no location and
SEVERITY_ERROR . |
static XmlError |
forMessage(String message,
int severity)
Returns an XmlError for the given message, with no location and the given severity.
|
static XmlError |
forMessage(String code,
Object[] args)
Returns an XmlError for the given message, with no location and the given severity.
|
static XmlError |
forMessage(String code,
Object[] args,
int severity)
Returns an XmlError for the given message, with no location and the given severity.
|
static XmlError |
forObject(String message,
int severity,
XmlObject xobj)
Returns an XmlError for the given message, with the given severity, located at the XmlObject.
|
static XmlError |
forObject(String code,
Object[] args,
int severity,
XmlObject xobj)
Returns an XmlError for the given message, with the given severity, located at the XmlObject.
|
static XmlError |
forObject(String code,
Object[] args,
XmlObject xobj)
Returns an XmlError for the given message, located at the XmlObject, with
SEVERITY_ERROR . |
static XmlError |
forObject(String message,
XmlObject xobj)
Returns an XmlError for the given message, located at the XmlObject, with
SEVERITY_ERROR . |
static XmlError |
forSource(String message,
int severity,
String sourceName)
Returns an XmlError for the given message, with the given severity, located in the given file.
|
static XmlError |
forSource(String code,
Object[] args,
int severity,
String sourceName)
Returns an XmlError for the given message, with the given severity, located in the given file.
|
static XmlError |
forSource(String message,
String sourceName)
Returns an XmlError for the given message, located in the given file and
SEVERITY_ERROR . |
int |
getColumn()
Returns the column number of the error, if available, -1 if not.
|
XmlCursor |
getCursorLocation()
Returns a location of the error as an
XmlCursor , null if
not available. |
String |
getErrorCode()
Returns the error code or null.
|
int |
getLine()
Returns the line number of the error, if available, -1 if not.
|
Object |
getLocation(Object type)
Returns a location object of the given type.
|
String |
getMessage()
Returns the error message without location information.
|
XmlObject |
getObjectLocation()
Returns a location of the error as an
XmlObject , null if
not available. |
int |
getOffset()
Returns the file character offset of the error, if available, -1 if not.
|
int |
getSeverity()
Returns the severity.
|
String |
getSourceName()
Returns the URL (or other name) of the file with the error, if available.
|
static String |
severityAsString(int severity) |
String |
toString()
Produces a standard string for the error message, complete with
filename and location offsets if available.
|
String |
toString(URI base)
Produces a standard string with the error message.
|
public static final int SEVERITY_ERROR
getSeverity()
.public static final int SEVERITY_WARNING
getSeverity()
.public static final int SEVERITY_INFO
getSeverity()
.public XmlError(XmlError src)
src
- The original XmlError to copy.public static XmlError forMessage(String message)
SEVERITY_ERROR
.message
- the error messagepublic static XmlError forMessage(String message, int severity)
message
- the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)public static XmlError forMessage(String code, Object[] args)
code
- the error codeargs
- the arguments to use in formatting the error messagepublic static XmlError forMessage(String code, Object[] args, int severity)
code
- the error codeargs
- the arguments to use in formatting the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)public static XmlError forSource(String message, String sourceName)
SEVERITY_ERROR
.message
- the error messagesourceName
- the URL or other name for the filepublic static XmlError forSource(String message, int severity, String sourceName)
message
- the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)sourceName
- the URL or other name for the filepublic static XmlError forSource(String code, Object[] args, int severity, String sourceName)
code
- the error codeargs
- the arguments to use in formatting the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)sourceName
- the URL or other name for the filepublic static XmlError forLocation(String message, String sourceName, Location location)
SEVERITY_ERROR
.message
- the error messagesourceName
- the URL or other name for the filelocation
- the location from an xml streampublic static XmlError forLocation(String message, String sourceName, int line, int column, int offset)
SEVERITY_ERROR
.message
- the error messagesourceName
- the URL or other name for the fileline
- the 1-based line number, or -1 if not knowncolumn
- the 1-based column number, or -1 if not knownoffset
- the 0-base file character offset, or -1 if not knownpublic static XmlError forLocation(String code, Object[] args, int severity, String sourceName, int line, int column, int offset)
code
- the error codeargs
- the arguments to use in formatting the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)sourceName
- the URL or other name for the fileline
- the 1-based line number, or -1 if not knowncolumn
- the 1-based column number, or -1 if not knownoffset
- the 0-base file character offset, or -1 if not knownpublic static XmlError forLocation(String message, int severity, String sourceName, int line, int column, int offset)
message
- the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)sourceName
- the URL or other name for the fileline
- the 1-based line number, or -1 if not knowncolumn
- the 1-based column number, or -1 if not knownoffset
- the 0-base file character offset, or -1 if not knownpublic static XmlError forLocationAndCursor(String message, int severity, String sourceName, int line, int column, int offset, XmlCursor cursor)
message
- the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)sourceName
- the URL or other name for the fileline
- the 1-based line number, or -1 if not knowncolumn
- the 1-based column number, or -1 if not knownoffset
- the 0-base file character offset, or -1 if not knowncursor
- the XmlCursor representing the location of the errorpublic static XmlError forObject(String message, XmlObject xobj)
SEVERITY_ERROR
.message
- the error messagexobj
- the XmlObject representing the location of the errorpublic static XmlError forObject(String code, Object[] args, XmlObject xobj)
SEVERITY_ERROR
.code
- the error codeargs
- the arguments to use in formatting the error messagexobj
- the XmlObject representing the location of the errorpublic static XmlError forObject(String message, int severity, XmlObject xobj)
message
- the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)xobj
- the XmlObject representing the location of the errorpublic static XmlError forObject(String code, Object[] args, int severity, XmlObject xobj)
code
- the error codeargs
- the arguments to use in formatting the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)xobj
- the XmlObject representing the location of the errorpublic static XmlError forCursor(String message, XmlCursor cursor)
SEVERITY_ERROR
.message
- the error messagecursor
- the XmlCursor representing the location of the errorpublic static XmlError forCursor(String code, Object[] args, XmlCursor cursor)
SEVERITY_ERROR
.code
- the error codeargs
- the arguments to use in formatting the error messagecursor
- the XmlCursor representing the location of the errorpublic static XmlError forCursor(String message, int severity, XmlCursor cursor)
message
- the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)cursor
- the XmlCursor representing the location of the errorpublic static XmlError forCursor(String code, Object[] args, int severity, XmlCursor cursor)
code
- the error codeargs
- the arguments to use in formatting the error messageseverity
- the severity (SEVERITY_ERROR
, SEVERITY_WARNING
, or SEVERITY_INFO
)cursor
- the XmlCursor representing the location of the errorpublic static String formattedMessage(String code, Object[] args)
public int getSeverity()
public String getMessage()
public String getErrorCode()
XmlErrorCodes
.public String getSourceName()
public int getLine()
public int getColumn()
public int getOffset()
public Object getLocation(Object type)
public XmlCursor getCursorLocation()
XmlCursor
, null if
not available.public XmlObject getObjectLocation()
XmlObject
, null if
not available.public String toString()
public String toString(URI base)
public static String severityAsString(int severity)
Copyright © 2010 - 2020 Adobe. All Rights Reserved