com.thoughtworks.xstream.converters.javabean

Class JavaBeanConverter

java.lang.Object

com.thoughtworks.xstream.converters.javabean.JavaBeanConverter

All Implemented Interfaces:

Converter, ConverterMatcher

public class JavaBeanConverter
extends java.lang.Object
implements Converter

Can convert any bean with a public default constructor. The BeanProvider used as default is based on BeanInfo. Indexed properties are currently not supported.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaBeanConverter.DuplicateFieldException Deprecated. As of 1.3
static class	JavaBeanConverter.DuplicatePropertyException Exception to indicate double processing of a property to avoid silent clobbering.

Field Summary

Fields

Modifier and Type	Field and Description
protected JavaBeanProvider	beanProvider
protected Mapper	mapper

Constructor Summary

Constructors

Constructor and Description
JavaBeanConverter(Mapper mapper)
JavaBeanConverter(Mapper mapper, java.lang.Class type)
JavaBeanConverter(Mapper mapper, JavaBeanProvider beanProvider)
JavaBeanConverter(Mapper mapper, JavaBeanProvider beanProvider, java.lang.Class type)
JavaBeanConverter(Mapper mapper, java.lang.String classAttributeIdentifier) Deprecated. As of 1.3, use JavaBeanConverter(Mapper) and XStream.aliasAttribute(String, String)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canConvert(java.lang.Class type) Checks if the bean provider can instantiate this type.
void	marshal(java.lang.Object source, HierarchicalStreamWriter writer, MarshallingContext context) Convert an object to textual data.
java.lang.Object	unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) Convert textual data back into an object.

Methods inherited from class java.lang.Object

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

Field Detail

mapper

protected final Mapper mapper

beanProvider

protected final JavaBeanProvider beanProvider

Constructor Detail

JavaBeanConverter

public JavaBeanConverter(Mapper mapper)

JavaBeanConverter

public JavaBeanConverter(Mapper mapper,
                 java.lang.Class type)

JavaBeanConverter

public JavaBeanConverter(Mapper mapper,
                 JavaBeanProvider beanProvider)

JavaBeanConverter

public JavaBeanConverter(Mapper mapper,
                 JavaBeanProvider beanProvider,
                 java.lang.Class type)

JavaBeanConverter

public JavaBeanConverter(Mapper mapper,
                 java.lang.String classAttributeIdentifier)

Deprecated. As of 1.3, use JavaBeanConverter(Mapper) and XStream.aliasAttribute(String, String)

Method Detail

canConvert

public boolean canConvert(java.lang.Class type)

Checks if the bean provider can instantiate this type. If you need less strict checks, subclass JavaBeanConverter

Specified by:

canConvert in interface ConverterMatcher

Parameters:

type - the Class representing the object type to be converted

marshal

public void marshal(java.lang.Object source,
           HierarchicalStreamWriter writer,
           MarshallingContext context)

Description copied from interface: Converter

Convert an object to textual data.

Specified by:

marshal in interface Converter

Parameters:

source - The object to be marshalled.

writer - A stream to write to.

context - A context that allows nested objects to be processed by XStream.

unmarshal

public java.lang.Object unmarshal(HierarchicalStreamReader reader,
                         UnmarshallingContext context)

Description copied from interface: Converter

Convert textual data back into an object.

Specified by:

unmarshal in interface Converter

Parameters:

reader - The stream to read the text from.

Returns:

The resulting object.