Overview Package Tree Index Deprecated About
 SVNKit Home
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.tmatesoft.svn.core

Class SVNErrorMessage

Implemented Interfaces:
Serializable
public class SVNErrorMessage
extends Object
implements Serializable
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

static int
TYPE_ERROR
Error messages of this type are considered to be errors (most critical) rather than warnings.
static int
TYPE_WARNING
Error messages of this type are considered to be warnings, what in certain situations may be OK.
static SVNErrorMessage
UNKNOWN_ERROR_MESSAGE
This is a type of an error message denoting an error of an unknown nature.

Constructor Summary

SVNErrorMessage(SVNErrorCode code, String message, Object[] relatedObjects, int type)

Method Summary

static SVNErrorMessage
create(SVNErrorCode code)
Creates an error message given an error code.
static SVNErrorMessage
create(SVNErrorCode code, String message)
Creates an error message given an error code and description.
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.
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.
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.
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.
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).
SVNErrorMessage
getChildErrorMessage()
Returns an error message (if any) that was returned from a deeper method call.
SVNErrorCode
getErrorCode()
Returns the error code of the error.
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.
String
getMessage()
Returns an error description formatted with the related objects if needed.
String
getMessageTemplate()
Returns an error description which may contain message format patterns.
Object[]
getRelatedObjects()
Returns objects (if any) that were provided to be formatted with the error description.
int
getType()
Returns the type of the error (whether it's a warning or an error).
boolean
hasChildErrorMessage()
Says if this error message object has got a child error message.
boolean
isWarning()
Returns true if this message is a warning message, not error one.
void
setChildErrorMessage(SVNErrorMessage childMessage)
Sets a child error message for this one.
String
toString()
Returns a string representation of this error message object formatting (if needed) the error description with the provided related objects.
SVNErrorMessage
wrap(String parentMessage)
Wraps this error message into a new one that is returned as a parent error message.
SVNErrorMessage
wrap(String parentMessage, Object relatedObject)
Wraps this error message into a new one that is returned as a parent error message.

Field Details

TYPE_ERROR

public static final int TYPE_ERROR
Error messages of this type are considered to be errors (most critical) rather than warnings.
Field Value:
0

TYPE_WARNING

public static final int TYPE_WARNING
Error messages of this type are considered to be warnings, what in certain situations may be OK.
Field Value:
1

UNKNOWN_ERROR_MESSAGE

public static SVNErrorMessage UNKNOWN_ERROR_MESSAGE
This is a type of an error message denoting an error of an unknown nature. This corresponds to an SVNErrorCode.UNKNOWN error.

Constructor Details

SVNErrorMessage

protected SVNErrorMessage(SVNErrorCode code,
                          String message,
                          Object[] relatedObjects,
                          int type)

Method Details

create

public static SVNErrorMessage create(SVNErrorCode code)
Creates an error message given an error code.
Parameters:
code - an error code
Returns:
a new error message

create

public static SVNErrorMessage create(SVNErrorCode code,
                                     String message)
Creates an error message given an error code and description.
Parameters:
code - an error code
message - an error description
Returns:
a new error message

create

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. To format the provided object with the message, you should use valid format patterns parsable for MessageFormat.
Parameters:
code - an error code
message - an error description
object - an object related to the error message
Returns:
a new error message

create

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. To format the provided object with the message, you should use valid format patterns parsable for MessageFormat.
Parameters:
code - an error code
message - an error description
object - an object related to the error message
type - an error type
Returns:
a new error message

create

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. To format the provided objects with the message, you should use valid format patterns parsable for MessageFormat.
Parameters:
code - an error code
message - an error description
objects - an array of objects related to the error message
Returns:
a new error message

create

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. To format the provided objects with the message, you should use valid format patterns parsable for MessageFormat.
Parameters:
code - an error code
message - an error description
objects - an array of objects related to the error message
type - an error type
Returns:
a new error message

create

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).
Parameters:
code - an error code
message - an error description
type - an error type
Returns:
a new error message

getChildErrorMessage

public SVNErrorMessage getChildErrorMessage()
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.
Returns:
a child error message object (if this object is not the first one)

getErrorCode

public SVNErrorCode getErrorCode()
Returns the error code of the error.
Returns:
th error code of the error

getFullMessage

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.
Returns:
a string representing a full list of error messages

getMessage

public String getMessage()
Returns an error description formatted with the related objects if needed. This call is equivalent to a call to toString()
Returns:
an error message

getMessageTemplate

public String getMessageTemplate()
Returns an error description which may contain message format patterns.
Returns:
an error description

getRelatedObjects

public Object[] getRelatedObjects()
Returns objects (if any) that were provided to be formatted with the error description. Objects are formatted by the standard MessageFormat engine.
Returns:
an array of objects

getType

public int getType()
Returns the type of the error (whether it's a warning or an error).
Returns:
the type of this error message

hasChildErrorMessage

public boolean hasChildErrorMessage()
Says if this error message object has got a child error message.
Returns:
true if has, false otherwise (for example, an initial error message would not have a child error message)

isWarning

public boolean isWarning()
Returns true if this message is a warning message, not error one.
Returns:
true or false

setChildErrorMessage

public void setChildErrorMessage(SVNErrorMessage childMessage)
Sets a child error message for this one.
Parameters:
childMessage - a child error message

toString

public String toString()
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).
Returns:
a string representing this object.

wrap

public SVNErrorMessage wrap(String parentMessage)
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
Returns:
a parent error message

wrap

public SVNErrorMessage wrap(String parentMessage,
                            Object relatedObject)
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
relatedObject - an object to be formatted with parentMessage
Returns:
a parent error message

Overview Package Tree Index Deprecated About
Copyright © 2004-2006 TMate Software Ltd. All Rights Reserved.