Top Description Fields Constructors Methods
com.thoughtworks.xstream.converters.extended

public Class JavaFieldConverter

extends Object
implements Converter
Class Inheritance
All Implemented Interfaces
com.thoughtworks.xstream.converters.Converter, com.thoughtworks.xstream.converters.ConverterMatcher
Imports
com.thoughtworks.xstream.converters.ConversionException, .Converter, .MarshallingContext, .SingleValueConverter, .UnmarshallingContext, com.thoughtworks.xstream.core.ClassLoaderReference, com.thoughtworks.xstream.io.HierarchicalStreamReader, .HierarchicalStreamWriter, com.thoughtworks.xstream.mapper.DefaultMapper, .Mapper, java.lang.reflect.Field
Converts a java.lang.reflect.Field to XML.
Author
Jörg Schaible

Field Summary

Modifier and TypeField and Description
private final SingleValueConverter
javaClassConverter

private final Mapper
mapper

Constructor Summary

AccessConstructor and Description
public
JavaFieldConverter(ClassLoaderReference
the reference to the ClassLoader of the XStream instance
classLoaderReference)

Construct a JavaFieldConverter.

public
JavaFieldConverter(ClassLoader classLoader)

Deprecated As of 1.4.5 use JavaFieldConverter(ClassLoaderReference)
protected
JavaFieldConverter(SingleValueConverter
the converter to use
javaClassConverter, Mapper
to use
mapper)

Construct a JavaFieldConverter.

Method Summary

Modifier and TypeMethod and Description
public boolean
canConvert(Class<T>
the Class representing the object type to be converted
type)

Implements com.thoughtworks.xstream.converters.ConverterMatcher.canConvert.

Determines whether the converter can marshall a particular type.
public void
marshal(Object
The object to be marshalled.
source, HierarchicalStreamWriter
A stream to write to.
writer, MarshallingContext
A context that allows nested objects to be processed by XStream.
context)

Implements com.thoughtworks.xstream.converters.Converter.marshal.

Convert an object to textual data.
public Object
unmarshal(HierarchicalStreamReader
The stream to read the text from.
reader, UnmarshallingContext context)

Implements com.thoughtworks.xstream.converters.Converter.unmarshal.

Convert textual data back into an object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

javaClassConverterback to summary
private final SingleValueConverter javaClassConverter
mapperback to summary
private final Mapper mapper

Constructor Detail

JavaFieldConverterback to summary
public JavaFieldConverter(ClassLoaderReference classLoaderReference)

Construct a JavaFieldConverter.

Parameters
classLoaderReference:ClassLoaderReference

the reference to the ClassLoader of the XStream instance

Since
1.4.5
JavaFieldConverterback to summary
public JavaFieldConverter(ClassLoader classLoader)

Deprecated

As of 1.4.5 use JavaFieldConverter(ClassLoaderReference)

JavaFieldConverterback to summary
protected JavaFieldConverter(SingleValueConverter javaClassConverter, Mapper mapper)

Construct a JavaFieldConverter. Depending on the mapper chain the converter will also respect aliases.

Parameters
javaClassConverter:SingleValueConverter

the converter to use

mapper:Mapper

to use

Since
1.4.5

Method Detail

canConvertback to summary
public boolean canConvert(Class<T> type)

Implements com.thoughtworks.xstream.converters.ConverterMatcher.canConvert.

Doc from com.thoughtworks.xstream.converters.ConverterMatcher.canConvert.

Determines whether the converter can marshall a particular type.

Parameters
type:Class<T>

the Class representing the object type to be converted

marshalback to summary
public void marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context)

Implements com.thoughtworks.xstream.converters.Converter.marshal.

Doc from com.thoughtworks.xstream.converters.Converter.marshal.

Convert an object to textual data.

Parameters
source:Object

The object to be marshalled.

writer:HierarchicalStreamWriter

A stream to write to.

context:MarshallingContext

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

unmarshalback to summary
public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context)

Implements com.thoughtworks.xstream.converters.Converter.unmarshal.

Doc from com.thoughtworks.xstream.converters.Converter.unmarshal.

Convert textual data back into an object.

Parameters
reader:HierarchicalStreamReader

The stream to read the text from.

Returns:Object

The resulting object.