Top Description Inners Fields Constructors Methods
org.jboss.marshalling

public final Class TraceInformation

extends Throwable
Class Inheritance
Imports
org.jboss.marshalling.reflect.SerializableClass, .SerializableField, java.io.Serializable

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.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
TraceInformation.ClassInfo

Information about a class which was being (un-)marshalled at the time an exception occurred.

public static class
TraceInformation.FieldInfo

Information about a field which was being marshalled at the time an exception occurred.

public static class
TraceInformation.IncompleteObjectInfo

Information about an incomplete object being unmarshalled.

public static class
TraceInformation.IndexInfo

Information about an index in an array or collection.

public static enum
TraceInformation.IndexType

The type of index for a multi-valued collection or map.

public abstract static class
TraceInformation.Info

Information about the circumstances surrounding (un)marshalling.

public static class
TraceInformation.MethodInfo

Information specific to a method execution.

public static class
TraceInformation.ObjectInfo

Information about an object which was being (un-)marshalled at the time an exception occurred.

public static class
TraceInformation.UserInfo

User information.

Field Summary

Modifier and TypeField and Description
pack-priv TraceInformation.Info
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public static void
addFieldInformation(Throwable
the throwable to update
t
,
String
the field name being (un-)marshalled
fieldName
)

Add information about a field which was being marshalled.

public static void
addFieldInformation(Throwable
the throwable to update
t
,
SerializableClass
Reference to the class that owns the field.
owner
,
SerializableField
The field being (un-)marshalled.
field
)

Add information about a field which was being marshalled.

public static void
addIncompleteObjectInformation(Throwable
the throwable to update
t
,
Class<?>
the class of the target object being unmarshalled
targetClass
)

Add information about an incomplete object which was being unmarshalled.

public static void
addIncompleteObjectInformation(Throwable
the throwable to update
t
,
String
the class of the target object being unmarshalled
targetClassName
)

Add information about an incomplete object which was being unmarshalled.

public static void
addIndexInformation(Throwable
the throwable to update
t
,
int
the index of the element in question
index
,
int
the size of the collection in question
size
,
TraceInformation.IndexType
the type of element being processed
kind
)

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

public static void
addObjectInformation(Throwable
the throwable to update
t
,
Object
the target object which was being (un-)marshalled
targetObject
)

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

public static void
addUserInformation(Throwable
the throwable to update
t
,
Serializable
the user data
data
)

Add user information about problem with marshalling or unmarshalling.

public Throwable
fillInStackTrace()

Overrides java.lang.Throwable.fillInStackTrace.

Fills in the execution stack trace.
private static String
private static TraceInformation
public void
setStackTrace(final StackTraceElement[]
the stack trace elements to be associated with this Throwable. The specified array is copied by this call; changes in the specified array after the method invocation returns will have no effect on this Throwable's stack trace.
stackTrace
)

Overrides java.lang.Throwable.setStackTrace.

Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
public String
toString()

Overrides java.lang.Throwable.toString.

Returns a short description of this throwable.
Inherited from java.lang.Throwable:
addSuppressedgetCausegetLocalizedMessagegetMessagegetStackTracegetSuppressedinitCauseprintStackTraceprintStackTraceprintStackTrace

Field Detail

infoback to summary
pack-priv TraceInformation.Info info
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Throwable.serialVersionUID.

Constructor Detail

TraceInformationback to summary
pack-priv TraceInformation()

Method Detail

addFieldInformationback to summary
public static void addFieldInformation(Throwable t, String fieldName)

Add information about a field which was being marshalled.

Parameters
t:Throwable

the throwable to update

fieldName:String

the field name being (un-)marshalled

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

Add information about a field which was being marshalled.

Parameters
t:Throwable

the throwable to update

owner:SerializableClass

Reference to the class that owns the field.

field:SerializableField

The field being (un-)marshalled.

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

Add information about an incomplete object which was being unmarshalled.

Parameters
t:Throwable

the throwable to update

targetClass:Class<?>

the class of the target object being unmarshalled

addIncompleteObjectInformationback to summary
public static void addIncompleteObjectInformation(Throwable t, String targetClassName)

Add information about an incomplete object which was being unmarshalled.

Parameters
t:Throwable

the throwable to update

targetClassName:String

the class of the target object being unmarshalled

addIndexInformationback to summary
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:Throwable

the throwable to update

index:int

the index of the element in question

size:int

the size of the collection in question

kind:TraceInformation.IndexType

the type of element being processed

addObjectInformationback to summary
public static void addObjectInformation(Throwable t, Object targetObject)

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

Parameters
t:Throwable

the throwable to update

targetObject:Object

the target object which was being (un-)marshalled

addUserInformationback to summary
public static void addUserInformation(Throwable t, Serializable data)

Add user information about problem with marshalling or unmarshalling.

Parameters
t:Throwable

the throwable to update

data:Serializable

the user data

fillInStackTraceback to summary
public Throwable fillInStackTrace()

Overrides java.lang.Throwable.fillInStackTrace.

Doc from java.lang.Throwable.fillInStackTrace.

Fills in the execution stack trace. This method records within this Throwable object information about the current state of the stack frames for the current thread.

If the stack trace of this Throwable is not writable, calling this method has no effect.

Returns:Throwable

a reference to this Throwable instance.

getNiceClassNameback to summary
private static String getNiceClassName(Class<?> clazz)
getOrAddTraceInformationback to summary
private static TraceInformation getOrAddTraceInformation(Throwable t)
setStackTraceback to summary
public void setStackTrace(final StackTraceElement[] stackTrace)

Overrides java.lang.Throwable.setStackTrace.

Doc from java.lang.Throwable.setStackTrace.

Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods. This method, which is designed for use by RPC frameworks and other advanced systems, allows the client to override the default stack trace that is either generated by fillInStackTrace() when a throwable is constructed or deserialized when a throwable is read from a serialization stream.

If the stack trace of this Throwable is not writable, calling this method has no effect other than validating its argument.

Parameters
stackTrace:StackTraceElement[]

the stack trace elements to be associated with this Throwable. The specified array is copied by this call; changes in the specified array after the method invocation returns will have no effect on this Throwable's stack trace.

toStringback to summary
public String toString()

Overrides java.lang.Throwable.toString.

Doc from java.lang.Throwable.toString.

Returns a short description of this throwable. The result is the concatenation of:

  • the name of the class of this object
  • ": " (a colon and a space)
  • the result of invoking this object's getLocalizedMessage method
If getLocalizedMessage returns null, then just the class name is returned.
Returns:String

a string representation of this throwable.

org.jboss.marshalling back to summary

public final Class TraceInformation.ClassInfo

extends Info
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Information about a class which was being (un-)marshalled at the time an exception occurred.

Field Summary

Modifier and TypeField and Description
private static final long
private final String

Constructor Summary

AccessConstructor and Description
pack-priv
ClassInfo(final TraceInformation.Info cause, final String targetClassName)

Method Summary

Modifier and TypeMethod and Description
public String
protected void
Inherited from org.jboss.marshalling.TraceInformation.Info:
getCausetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jboss.marshalling.TraceInformation.Info.serialVersionUID.

targetClassNameback to summary
private final String targetClassName

Constructor Detail

ClassInfoback to summary
pack-priv ClassInfo(final TraceInformation.Info cause, final String targetClassName)

Method Detail

getTargetClassNameback to summary
public String getTargetClassName()
toStringback to summary
protected void toString(final StringBuilder builder)

Overrides org.jboss.marshalling.TraceInformation.Info.toString.

org.jboss.marshalling back to summary

public final Class TraceInformation.FieldInfo

extends Info
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Information about a field which was being marshalled at the time an exception occurred.

Field Summary

Modifier and TypeField and Description
private final String
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
FieldInfo(final TraceInformation.Info cause, final String fieldName)

Method Summary

Modifier and TypeMethod and Description
protected void
Inherited from org.jboss.marshalling.TraceInformation.Info:
getCausetoString

Field Detail

fieldNameback to summary
private final String fieldName
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jboss.marshalling.TraceInformation.Info.serialVersionUID.

Constructor Detail

FieldInfoback to summary
pack-priv FieldInfo(final TraceInformation.Info cause, final String fieldName)

Method Detail

toStringback to summary
protected void toString(final StringBuilder builder)

Overrides org.jboss.marshalling.TraceInformation.Info.toString.

org.jboss.marshalling back to summary

public final Class TraceInformation.IncompleteObjectInfo

extends Info
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Information about an incomplete object being unmarshalled.

Field Summary

Modifier and TypeField and Description
private static final long
private final String

Constructor Summary

AccessConstructor and Description
public
IncompleteObjectInfo(final TraceInformation.Info cause, final String targetClassName)

Method Summary

Modifier and TypeMethod and Description
public String
protected void
Inherited from org.jboss.marshalling.TraceInformation.Info:
getCausetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jboss.marshalling.TraceInformation.Info.serialVersionUID.

targetClassNameback to summary
private final String targetClassName

Constructor Detail

IncompleteObjectInfoback to summary
public IncompleteObjectInfo(final TraceInformation.Info cause, final String targetClassName)

Method Detail

getTargetClassNameback to summary
public String getTargetClassName()
toStringback to summary
protected void toString(StringBuilder builder)

Overrides org.jboss.marshalling.TraceInformation.Info.toString.

org.jboss.marshalling back to summary

public final Class TraceInformation.IndexInfo

extends Info
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Information about an index in an array or collection.

Field Summary

Modifier and TypeField and Description
private final int
private final TraceInformation.IndexType
private static final long
private final int

Constructor Summary

AccessConstructor and Description
pack-priv
IndexInfo(final TraceInformation.Info cause, final int idx, final int size, final TraceInformation.IndexType kind)

Method Summary

Modifier and TypeMethod and Description
protected void
Inherited from org.jboss.marshalling.TraceInformation.Info:
getCausetoString

Field Detail

idxback to summary
private final int idx
kindback to summary
private final TraceInformation.IndexType kind
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jboss.marshalling.TraceInformation.Info.serialVersionUID.

sizeback to summary
private final int size

Constructor Detail

IndexInfoback to summary
pack-priv IndexInfo(final TraceInformation.Info cause, final int idx, final int size, final TraceInformation.IndexType kind)

Method Detail

toStringback to summary
protected void toString(final StringBuilder builder)

Overrides org.jboss.marshalling.TraceInformation.Info.toString.

org.jboss.marshalling back to summary

public final Enum TraceInformation.IndexType

extends Enum<TraceInformation.IndexType>
Class Inheritance

The type of index for a multi-valued collection or map.

Field Summary

Modifier and TypeField and Description
public static final TraceInformation.IndexType
public static final TraceInformation.IndexType
public static final TraceInformation.IndexType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static TraceInformation.IndexType
public static TraceInformation.IndexType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ELEMENTback to summary
public static final TraceInformation.IndexType ELEMENT
MAP_KEYback to summary
public static final TraceInformation.IndexType MAP_KEY
MAP_VALUEback to summary
public static final TraceInformation.IndexType MAP_VALUE

Constructor Detail

IndexTypeback to summary
private IndexType()

Method Detail

valueOfback to summary
public static TraceInformation.IndexType valueOf(String name)
valuesback to summary
public static TraceInformation.IndexType[] values()
org.jboss.marshalling back to summary

public abstract Class TraceInformation.Info

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Known Direct Subclasses
org.jboss.marshalling.TraceInformation.MethodInfo, org.jboss.marshalling.TraceInformation.ObjectInfo, org.jboss.marshalling.TraceInformation.ClassInfo, org.jboss.marshalling.TraceInformation.IncompleteObjectInfo, org.jboss.marshalling.TraceInformation.FieldInfo, org.jboss.marshalling.TraceInformation.IndexInfo, org.jboss.marshalling.TraceInformation.UserInfo

Information about the circumstances surrounding (un)marshalling.

Field Summary

Modifier and TypeField and Description
private final TraceInformation.Info
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
Info(final TraceInformation.Info cause)

Method Summary

Modifier and TypeMethod and Description
public TraceInformation.Info
protected void
public final String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

causeback to summary
private final TraceInformation.Info cause
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Infoback to summary
pack-priv Info(final TraceInformation.Info cause)

Method Detail

getCauseback to summary
public TraceInformation.Info getCause()
toStringback to summary
protected void toString(StringBuilder builder)
toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

org.jboss.marshalling back to summary

public final Class TraceInformation.MethodInfo

extends Info
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Information specific to a method execution.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
TraceInformation.MethodInfo.Type

The type of method being executed.

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Inherited from org.jboss.marshalling.TraceInformation.Info:
getCausetoStringtoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jboss.marshalling.TraceInformation.Info.serialVersionUID.

Constructor Detail

MethodInfoback to summary
pack-priv MethodInfo(final TraceInformation.Info cause)
org.jboss.marshalling back to summary

public final Enum TraceInformation.MethodInfo.Type

extends Enum<TraceInformation.MethodInfo.Type>
Class Inheritance

The type of method being executed.

Constructor Summary

AccessConstructor and Description
private
Type()

Field Detail

EXTERNALIZABLE_READ_OBJECTback to summary
public static final TraceInformation.MethodInfo.Type EXTERNALIZABLE_READ_OBJECT
EXTERNALIZABLE_WRITE_OBJECTback to summary
public static final TraceInformation.MethodInfo.Type EXTERNALIZABLE_WRITE_OBJECT
EXTERNALIZER_CREATE_OBJECTback to summary
public static final TraceInformation.MethodInfo.Type EXTERNALIZER_CREATE_OBJECT
EXTERNALIZER_READ_OBJECTback to summary
public static final TraceInformation.MethodInfo.Type EXTERNALIZER_READ_OBJECT
EXTERNALIZER_WRITE_OBJECTback to summary
public static final TraceInformation.MethodInfo.Type EXTERNALIZER_WRITE_OBJECT
READ_OBJECTback to summary
public static final TraceInformation.MethodInfo.Type READ_OBJECT
READ_OBJECT_NO_DATAback to summary
public static final TraceInformation.MethodInfo.Type READ_OBJECT_NO_DATA
WRITE_OBJECTback to summary
public static final TraceInformation.MethodInfo.Type WRITE_OBJECT

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static TraceInformation.MethodInfo.Type valueOf(String name)
valuesback to summary
public static TraceInformation.MethodInfo.Type[] values()
org.jboss.marshalling back to summary

public final Class TraceInformation.ObjectInfo

extends Info
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Information about an object which was being (un-)marshalled at the time an exception occurred.

Field Summary

Modifier and TypeField and Description
private static final long
private final String
private final int

Constructor Summary

AccessConstructor and Description
pack-priv
ObjectInfo(final TraceInformation.Info cause, final String targetClassName, final int targetHashCode)

Method Summary

Modifier and TypeMethod and Description
public String
public int
protected void
Inherited from org.jboss.marshalling.TraceInformation.Info:
getCausetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jboss.marshalling.TraceInformation.Info.serialVersionUID.

targetClassNameback to summary
private final String targetClassName
targetHashCodeback to summary
private final int targetHashCode

Constructor Detail

ObjectInfoback to summary
pack-priv ObjectInfo(final TraceInformation.Info cause, final String targetClassName, final int targetHashCode)

Method Detail

getTargetClassNameback to summary
public String getTargetClassName()
getTargetHashCodeback to summary
public int getTargetHashCode()
toStringback to summary
protected void toString(final StringBuilder builder)

Overrides org.jboss.marshalling.TraceInformation.Info.toString.

org.jboss.marshalling back to summary

public final Class TraceInformation.UserInfo

extends Info
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

User information.

Field Summary

Modifier and TypeField and Description
private final Serializable
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
UserInfo(final TraceInformation.Info cause, final Serializable data)

Method Summary

Modifier and TypeMethod and Description
protected void
Inherited from org.jboss.marshalling.TraceInformation.Info:
getCausetoString

Field Detail

databack to summary
private final Serializable data
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jboss.marshalling.TraceInformation.Info.serialVersionUID.

Constructor Detail

UserInfoback to summary
pack-priv UserInfo(final TraceInformation.Info cause, final Serializable data)

Method Detail

toStringback to summary
protected void toString(final StringBuilder builder)

Overrides org.jboss.marshalling.TraceInformation.Info.toString.