Class SerializableConverter

java.lang.Object

com.thoughtworks.xstream.converters.reflection.AbstractReflectionConverter

com.thoughtworks.xstream.converters.reflection.SerializableConverter

All Implemented Interfaces:

Converter, ConverterMatcher, Caching

Direct Known Subclasses:

CGLIBEnhancedConverter, LambdaConverter

public class SerializableConverter
extends AbstractReflectionConverter

Emulates the mechanism used by standard Java Serialization for classes that implement java.io.Serializable AND implement or inherit a custom readObject()/writeObject() method.

Supported features of serialization

• readObject(), writeObject()
• class inheritance
• readResolve(), writeReplace()
• getFields(), putFields(), writeFields(), readFields()
• ObjectStreamField[] serialPersistentFields
• ObjectInputValidation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SerializableConverter.UnserializableParentsReflectionProvider

Nested classes/interfaces inherited from class AbstractReflectionConverter

AbstractReflectionConverter.DuplicateFieldException, AbstractReflectionConverter.UnknownFieldException

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ATTRIBUTE_CLASS
private static final String	ATTRIBUTE_NAME
private static final String	ATTRIBUTE_SERIALIZATION
private static final String	ATTRIBUTE_VALUE_CUSTOM
private final ClassLoaderReference	classLoaderReference
private static final String	ELEMENT_DEFAULT
private static final String	ELEMENT_FIELD
private static final String	ELEMENT_FIELDS
private static final String	ELEMENT_NULL
private static final String	ELEMENT_UNSERIALIZABLE_PARENTS

Fields inherited from class AbstractReflectionConverter

mapper, reflectionProvider, serializationMembers, serializationMethodInvoker

Constructor Summary

Constructors

Constructor	Description
SerializableConverter(Mapper mapper, ReflectionProvider reflectionProvider)	Deprecated. As of 1.4 use SerializableConverter(Mapper, ReflectionProvider, ClassLoaderReference)
SerializableConverter(Mapper mapper, ReflectionProvider reflectionProvider, ClassLoaderReference classLoaderReference)	Construct a SerializableConverter.
SerializableConverter(Mapper mapper, ReflectionProvider reflectionProvider, ClassLoader classLoader)	Deprecated. As of 1.4.5 use SerializableConverter(Mapper, ReflectionProvider, ClassLoaderReference)

Method Summary

Modifier and Type	Method	Description
boolean	canConvert(Class type)	Determines whether the converter can marshall a particular type.
void	doMarshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context)
protected void	doMarshalConditionally(Object source, HierarchicalStreamWriter writer, MarshallingContext context)
Object	doUnmarshal(Object result, HierarchicalStreamReader reader, UnmarshallingContext context)
protected Object	doUnmarshalConditionally(Object result, HierarchicalStreamReader reader, UnmarshallingContext context)
protected List	hierarchyFor(Class type)
private boolean	isSerializable(Class type)
protected void	marshalUnserializableParent(HierarchicalStreamWriter writer, MarshallingContext context, Object replacedSource)
private Object	readField(ObjectStreamField field, Class type, Object instance)

Methods inherited from class AbstractReflectionConverter

canAccess, flushCache, instantiateNewInstance, marshal, marshallField, readResolve, shouldUnmarshalField, shouldUnmarshalTransientFields, unmarshal, unmarshallField

Methods inherited from class Object

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

Field Details

ELEMENT_NULL

private static final String ELEMENT_NULL

See Also:

• Constant Field Values

ELEMENT_DEFAULT

private static final String ELEMENT_DEFAULT

See Also:

• Constant Field Values

ELEMENT_UNSERIALIZABLE_PARENTS

private static final String ELEMENT_UNSERIALIZABLE_PARENTS

See Also:

• Constant Field Values

ATTRIBUTE_CLASS

private static final String ATTRIBUTE_CLASS

See Also:

• Constant Field Values

ATTRIBUTE_SERIALIZATION

private static final String ATTRIBUTE_SERIALIZATION

See Also:

• Constant Field Values

ATTRIBUTE_VALUE_CUSTOM

private static final String ATTRIBUTE_VALUE_CUSTOM

See Also:

• Constant Field Values

ELEMENT_FIELDS

private static final String ELEMENT_FIELDS

See Also:

• Constant Field Values

ELEMENT_FIELD

private static final String ELEMENT_FIELD

See Also:

• Constant Field Values

ATTRIBUTE_NAME

private static final String ATTRIBUTE_NAME

See Also:

• Constant Field Values

classLoaderReference

private final ClassLoaderReference classLoaderReference

Constructor Details

SerializableConverter

public SerializableConverter(Mapper mapper,
 ReflectionProvider reflectionProvider,
 ClassLoaderReference classLoaderReference)

Construct a SerializableConverter.

Parameters:

mapper - the mapper chain instance

reflectionProvider - the reflection provider

classLoaderReference - the reference to the ClassLoader of the XStream instance

Since:

1.4.5

SerializableConverter

public SerializableConverter(Mapper mapper,
 ReflectionProvider reflectionProvider,
 ClassLoader classLoader)

Deprecated.

As of 1.4.5 use SerializableConverter(Mapper, ReflectionProvider, ClassLoaderReference)

SerializableConverter

public SerializableConverter(Mapper mapper,
 ReflectionProvider reflectionProvider)

Deprecated.

As of 1.4 use SerializableConverter(Mapper, ReflectionProvider, ClassLoaderReference)

Method Details

canConvert

public boolean canConvert(Class type)

Description copied from interface: ConverterMatcher

Determines whether the converter can marshall a particular type.

Parameters:

type - the Class representing the object type to be converted

isSerializable

private boolean isSerializable(Class type)

doMarshal

public void doMarshal(Object source,
 HierarchicalStreamWriter writer,
 MarshallingContext context)

Overrides:

doMarshal in class AbstractReflectionConverter

marshalUnserializableParent

protected void marshalUnserializableParent(HierarchicalStreamWriter writer,
 MarshallingContext context,
 Object replacedSource)

readField

private Object readField(ObjectStreamField field,
 Class type,
 Object instance)

hierarchyFor

protected List hierarchyFor(Class type)

doUnmarshal

public Object doUnmarshal(Object result,
 HierarchicalStreamReader reader,
 UnmarshallingContext context)

Overrides:

doUnmarshal in class AbstractReflectionConverter

doMarshalConditionally

protected void doMarshalConditionally(Object source,
 HierarchicalStreamWriter writer,
 MarshallingContext context)

doUnmarshalConditionally

protected Object doUnmarshalConditionally(Object result,
 HierarchicalStreamReader reader,
 UnmarshallingContext context)