org.jboss.marshalling

Class TraceInformation

java.lang.Object

java.lang.Throwable

org.jboss.marshalling.TraceInformation

All Implemented Interfaces:

Serializable

public final class TraceInformation
extends Throwable

A facility available to marshalling implementations which allows for detailed stack traces which trace the position in the object graph where a marshalling or unmarshalling problem has occurred.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TraceInformation.ClassInfo Information about a class which was being (un-)marshalled at the time an exception occurred.
static class	TraceInformation.FieldInfo Information about a field which was being marshalled at the time an exception occurred.
static class	TraceInformation.IncompleteObjectInfo Information about an incomplete object being unmarshalled.
static class	TraceInformation.IndexInfo Information about an index in an array or collection.
static class	TraceInformation.IndexType The type of index for a multi-valued collection or map.
static class	TraceInformation.Info Information about the circumstances surrounding (un)marshalling.
static class	TraceInformation.MethodInfo Information specific to a method execution.
static class	TraceInformation.ObjectInfo Information about an object which was being (un-)marshalled at the time an exception occurred.
static class	TraceInformation.UserInfo User information.

Method Summary

Modifier and Type	Method and Description
static void	addFieldInformation(Throwable t, SerializableClass owner, SerializableField field) Add information about a field which was being marshalled.
static void	addFieldInformation(Throwable t, String fieldName) Add information about a field which was being marshalled.
static void	addIncompleteObjectInformation(Throwable t, Class<?> targetClass) Add information about an incomplete object which was being unmarshalled.
static void	addIncompleteObjectInformation(Throwable t, String targetClassName) Add information about an incomplete object which was being unmarshalled.
static void	addIndexInformation(Throwable t, int index, int size, TraceInformation.IndexType kind) Add information about an index into a collection which was being (un-)marshalled.
static void	addObjectInformation(Throwable t, Object targetObject) Add information about an object which was being (un-)marshalled.
static void	addUserInformation(Throwable t, Serializable data) Add user information about problem with marshalling or unmarshalling.
Throwable	fillInStackTrace()
void	setStackTrace(StackTraceElement[] stackTrace)
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Method Detail

fillInStackTrace

public Throwable fillInStackTrace()

Overrides:

fillInStackTrace in class Throwable

toString

public String toString()

Overrides:

toString in class Throwable

setStackTrace

public void setStackTrace(StackTraceElement[] stackTrace)

Overrides:

setStackTrace in class Throwable

addUserInformation

public static void addUserInformation(Throwable t,
                                      Serializable data)

Add user information about problem with marshalling or unmarshalling.

Parameters:

t - the throwable to update

data - the user data

addFieldInformation

public static void addFieldInformation(Throwable t,
                                       String fieldName)

Add information about a field which was being marshalled.

Parameters:

t - the throwable to update

fieldName - the field name being (un-)marshalled

addFieldInformation

public static void addFieldInformation(Throwable t,
                                       SerializableClass owner,
                                       SerializableField field)

Add information about a field which was being marshalled.

Parameters:

t - the throwable to update

owner - Reference to the class that owns the field.

field - The field being (un-)marshalled.

addObjectInformation

public static void addObjectInformation(Throwable t,
                                        Object targetObject)

Add information about an object which was being (un-)marshalled.

Parameters:

t - the throwable to update

targetObject - the target object which was being (un-)marshalled

addIncompleteObjectInformation

public static void addIncompleteObjectInformation(Throwable t,
                                                  Class<?> targetClass)

Add information about an incomplete object which was being unmarshalled.

Parameters:

t - the throwable to update

targetClass - the class of the target object being unmarshalled

addIncompleteObjectInformation

public static void addIncompleteObjectInformation(Throwable t,
                                                  String targetClassName)

Add information about an incomplete object which was being unmarshalled.

Parameters:

t - the throwable to update

targetClassName - the class of the target object being unmarshalled

addIndexInformation

public static void addIndexInformation(Throwable t,
                                       int index,
                                       int size,
                                       TraceInformation.IndexType kind)

Add information about an index into a collection which was being (un-)marshalled.

Parameters:

t - the throwable to update

index - the index of the element in question

size - the size of the collection in question

kind - the type of element being processed