| java.lang.Object
 org.tmatesoft.svn.core.SVNErrorMessage
| SVNErrorMessage | | public class SVNErrorMessage implements Serializable(Code) | | The SVNErrorMessage class represents error and warning messages describing
reasons of exceptions occurred during runtime. An error message may be of two levels:
An error message may contain an error messages stack trace, what is useful for
error reason investigations. Also such a message contains an error code (
SVNErrorCode )
what gives an ability to find out what kind of an error it is.
Error messages may be formatted. SVNErrorMessage performs formatting with the
help of the JDK's
MessageFormat class. To make a formatted message, use
MessageFormat parsable format patterns and provide an array of related objects
when creating an SVNErrorMessage.
Error messages may be supplied within exceptions of the main exception type -
SVNException .
version:
1.1.1
author:
TMate Software Ltd. |
| Field Summary | |
| final public static int | TYPE_ERROR
Error messages of this type are considered to be errors (most critical) rather
than warnings. | | final public static int | TYPE_WARNING
Error messages of this type are considered to be warnings, what in certain
situations may be OK. | | public static SVNErrorMessage | UNKNOWN_ERROR_MESSAGE
This is a type of an error message denoting an error of an unknown nature. |
| Method Summary | |
| public static SVNErrorMessage | create(SVNErrorCode code)
Creates an error message given an error code. | | public static SVNErrorMessage | create(SVNErrorCode code, String message)
Creates an error message given an error code and description. | | public static SVNErrorMessage | create(SVNErrorCode code, Throwable cause)
Creates an error message given an error code and cause. | | public static SVNErrorMessage | create(SVNErrorCode code, String message, Object object)
Creates an error message given an error code, description and may be a related
object to be formatted with the error description. | | public static SVNErrorMessage | create(SVNErrorCode code, String message, Object[] objects)
Creates an error message given an error code, description and may be related
objects to be formatted with the error description. | | public static SVNErrorMessage | create(SVNErrorCode code, String message, int type)
Creates an error message given an error code, description and a type (
whether it's a warning or an error). | | public static SVNErrorMessage | create(SVNErrorCode code, String message, Object object, int type)
Creates an error message given an error code, description, an error type
(whether it's a warning or an error) and may be a related object to be
formatted with the error description. | | public static SVNErrorMessage | create(SVNErrorCode code, String message, Object[] objects, int type)
Creates an error message given an error code, description, an error type
(whether it's a warning or an error) and may be related objects to be
formatted with the error description. | | public Throwable | getCause()
Returns throwable that is cause of the error if any. | | public SVNErrorMessage | getChildErrorMessage()
Returns an error message (if any) that was returned from a
deeper method call. | | public SVNErrorCode | getErrorCode()
Returns the error code of the error. | | public String | getFullMessage()
Gets a string representation of the entire stack trace of
error messages (if they were provided) starting with the initial
cause of the error. | | public String | getMessage()
Returns an error description formatted with the
related objects if needed. | | public String | getMessageTemplate()
Returns an error description which may contain message format
patterns. | | public Object[] | getRelatedObjects()
Returns objects (if any) that were provided to be formatted
with the error description. | | public int | getType()
Returns the type of the error (whether it's a warning or an error). | | public boolean | hasChildErrorMessage()
Says if this error message object has got a child error message. | | public boolean | isWarning()
Returns true if this message is a warning message, not error one. | | public void | setChildErrorMessage(SVNErrorMessage childMessage)
Sets a child error message for this one. | | public String | toString()
Returns a string representation of this error message object
formatting (if needed) the error description with the provided related objects. | | public SVNErrorMessage | wrap(String parentMessage)
Wraps this error message into a new one that is returned as
a parent error message. | | public SVNErrorMessage | wrap(String parentMessage, Object relatedObject)
Wraps this error message into a new one that is returned as
a parent error message. | | public SVNErrorMessage | wrap(String parentMessage, Object[] relatedObjects)
|
| TYPE_ERROR | | final public static int TYPE_ERROR(Code) | | Error messages of this type are considered to be errors (most critical) rather
than warnings.
|
| TYPE_WARNING | | final public static int TYPE_WARNING(Code) | | Error messages of this type are considered to be warnings, what in certain
situations may be OK.
|
| create | | public static SVNErrorMessage create(SVNErrorCode code)(Code) | | Creates an error message given an error code.
Parameters:
code - an error code a new error message |
| create | | public static SVNErrorMessage create(SVNErrorCode code, String message)(Code) | | Creates an error message given an error code and description.
Parameters:
code - an error code
Parameters:
message - an error description a new error message |
| create | | public static SVNErrorMessage create(SVNErrorCode code, Throwable cause)(Code) | | Creates an error message given an error code and cause.
Parameters:
code - an error code
Parameters:
cause - cause of the error a new error message |
| create | | public static SVNErrorMessage create(SVNErrorCode code, String message, Object object)(Code) | | Creates an error message given an error code, description and may be a related
object to be formatted with the error description.
To format the provided object with the message, you
should use valid format patterns parsable for
MessageFormat .
Parameters:
code - an error code
Parameters:
message - an error description
Parameters:
object - an object related to the error message a new error message |
| create | | public static SVNErrorMessage create(SVNErrorCode code, String message, Object[] objects)(Code) | | Creates an error message given an error code, description and may be related
objects to be formatted with the error description.
To format the provided objects with the message, you
should use valid format patterns parsable for
MessageFormat .
Parameters:
code - an error code
Parameters:
message - an error description
Parameters:
objects - an array of objects related to the error message a new error message |
| create | | public static SVNErrorMessage create(SVNErrorCode code, String message, int type)(Code) | | Creates an error message given an error code, description and a type (
whether it's a warning or an error).
Parameters:
code - an error code
Parameters:
message - an error description
Parameters:
type - an error type a new error message |
| create | | public static SVNErrorMessage create(SVNErrorCode code, String message, Object object, int type)(Code) | | Creates an error message given an error code, description, an error type
(whether it's a warning or an error) and may be a related object to be
formatted with the error description. To format the provided object
with the message, you should use valid format patterns parsable for
MessageFormat .
Parameters:
code - an error code
Parameters:
message - an error description
Parameters:
object - an object related to the error message
Parameters:
type - an error type a new error message |
| create | | public static SVNErrorMessage create(SVNErrorCode code, String message, Object[] objects, int type)(Code) | | Creates an error message given an error code, description, an error type
(whether it's a warning or an error) and may be related objects to be
formatted with the error description. To format the provided objects
with the message, you should use valid format patterns parsable for
MessageFormat .
Parameters:
code - an error code
Parameters:
message - an error description
Parameters:
objects - an array of objects related to the error message
Parameters:
type - an error type a new error message |
| getCause | | public Throwable getCause()(Code) | | Returns throwable that is cause of the error if any.
throwable that caused error or null if not applicable or not known. |
| getChildErrorMessage | | public SVNErrorMessage getChildErrorMessage()(Code) | | Returns an error message (if any) that was returned from a
deeper method call. So the topmost error messages have the
entire chain of error messages down to the real error cause.
a child error message object (if this object is not the first one) |
| getErrorCode | | public SVNErrorCode getErrorCode()(Code) | | Returns the error code of the error.
th error code of the error |
| getFullMessage | | public String getFullMessage()(Code) | | Gets a string representation of the entire stack trace of
error messages (if they were provided) starting with the initial
cause of the error.
a string representing a full list of error messages |
| getMessage | | public String getMessage()(Code) | | Returns an error description formatted with the
related objects if needed. This call is equivalent to
a call to
SVNErrorMessage.toString() an error message |
| getMessageTemplate | | public String getMessageTemplate()(Code) | | Returns an error description which may contain message format
patterns.
an error description |
| getRelatedObjects | | public Object[] getRelatedObjects()(Code) | | Returns objects (if any) that were provided to be formatted
with the error description. Objects are formatted by the standard
MessageFormat engine.
an array of objects |
| getType | | public int getType()(Code) | | Returns the type of the error (whether it's a warning or an error).
the type of this error message |
| hasChildErrorMessage | | public boolean hasChildErrorMessage()(Code) | | Says if this error message object has got a child error message.
true if has, false otherwise (for example, an initial error message would not have a childerror message) |
| isWarning | | public boolean isWarning()(Code) | | Returns true if this message is a warning message, not error one.
true or false |
| setChildErrorMessage | | public void setChildErrorMessage(SVNErrorMessage childMessage)(Code) | | Sets a child error message for this one.
Parameters:
childMessage - a child error message |
| toString | | public String toString()(Code) | | Returns a string representation of this error message object
formatting (if needed) the error description with the provided related objects.
If no error description pattern has been provided, the return
value includes a string representation of the error code (see
SVNErrorCode ).
a string representing this object. |
| wrap | | public SVNErrorMessage wrap(String parentMessage)(Code) | | Wraps this error message into a new one that is returned as
a parent error message. A parent message is set the error code
of this error message, a new error description and this error
message as its child.
Parameters:
parentMessage - a parent error description a parent error message |
| wrap | | public SVNErrorMessage wrap(String parentMessage, Object relatedObject)(Code) | | Wraps this error message into a new one that is returned as
a parent error message. A parent message is set the error code
of this error message, a new error description and this error
message as its child.
Parameters:
parentMessage - a parent error description
Parameters:
relatedObject - an object to be formatted with parentMessage a parent error message |
|
|