Class AbstractCollectionConverter

java.lang.Object

com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter

All Implemented Interfaces:

Converter, ConverterMatcher

Direct Known Subclasses:

ArrayConverter, CollectionConverter, MapConverter, SubjectConverter

public abstract class AbstractCollectionConverter
extends Object
implements Converter

Base helper class for converters that need to handle collections of items (arrays, Lists, Maps, etc).

Typically, subclasses of this will converter the outer structure of the collection, loop through the contents and call readItem() or writeItem() for each item.

Field Summary

Fields

Modifier and Type	Field	Description
private final Mapper	mapper

Constructor Summary

Constructors

Constructor	Description
AbstractCollectionConverter(Mapper mapper)

Method Summary

Modifier and Type	Method	Description
abstract boolean	canConvert(Class type)	Determines whether the converter can marshall a particular type.
protected Object	createCollection(Class type)
protected Mapper	mapper()
abstract void	marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context)	Convert an object to textual data.
protected Object	readBareItem(HierarchicalStreamReader reader, UnmarshallingContext context, Object current)	Read a bare item of the collection from the reader.
protected Object	readCompleteItem(HierarchicalStreamReader reader, UnmarshallingContext context, Object current)	Read an item of the collection including the tags from the reader.
protected Object	readItem(HierarchicalStreamReader reader, UnmarshallingContext context, Object current)	Deprecated. As of 1.4.11 use readBareItem(HierarchicalStreamReader, UnmarshallingContext, Object) or readCompleteItem(HierarchicalStreamReader, UnmarshallingContext, Object) instead.
abstract Object	unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context)	Convert textual data back into an object.
protected void	writeBareItem(Object item, MarshallingContext context, HierarchicalStreamWriter writer)	Write the bare item of the collection into the writer.
protected void	writeCompleteItem(Object item, MarshallingContext context, HierarchicalStreamWriter writer)	Write an item of the collection into the writer including surrounding tags.
protected void	writeItem(Object item, MarshallingContext context, HierarchicalStreamWriter writer)	Deprecated. As of 1.4.11 use writeCompleteItem(Object, MarshallingContext, HierarchicalStreamWriter) instead.
protected void	writeNullItem(MarshallingContext context, HierarchicalStreamWriter writer)	Write a null item of the collection into the writer.

Methods inherited from class Object

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

Field Details

mapper

private final Mapper mapper

Constructor Details

AbstractCollectionConverter

public AbstractCollectionConverter(Mapper mapper)

Method Details

canConvert

public abstract boolean canConvert(Class type)

Description copied from interface: ConverterMatcher

Determines whether the converter can marshall a particular type.

Specified by:

canConvert in interface ConverterMatcher

Parameters:

type - the Class representing the object type to be converted

mapper

protected Mapper mapper()

marshal

public abstract void marshal(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 abstract 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.

context -

Returns:

The resulting object.

writeItem

protected void writeItem(Object item,
 MarshallingContext context,
 HierarchicalStreamWriter writer)

Deprecated.

As of 1.4.11 use writeCompleteItem(Object, MarshallingContext, HierarchicalStreamWriter) instead.

writeCompleteItem

protected void writeCompleteItem(Object item,
 MarshallingContext context,
 HierarchicalStreamWriter writer)

Write an item of the collection into the writer including surrounding tags.

Parameters:

item - the item to write

context - the current marshalling context

writer - the target writer

Since:

1.4.11

writeBareItem

protected void writeBareItem(Object item,
 MarshallingContext context,
 HierarchicalStreamWriter writer)

Write the bare item of the collection into the writer.

Parameters:

item - the item to write

context - the current marshalling context

writer - the target writer

Since:

1.4.11

writeNullItem

protected void writeNullItem(MarshallingContext context,
 HierarchicalStreamWriter writer)

Write a null item of the collection into the writer. The method readItem should be able to process the written data i.e. it has to write the tags or may not write anything at all.

Parameters:

context - the current marshalling context

writer - the target writer

Since:

1.4.11

readItem

protected Object readItem(HierarchicalStreamReader reader,
 UnmarshallingContext context,
 Object current)

Deprecated.

As of 1.4.11 use readBareItem(HierarchicalStreamReader, UnmarshallingContext, Object) or readCompleteItem(HierarchicalStreamReader, UnmarshallingContext, Object) instead.

readBareItem

protected Object readBareItem(HierarchicalStreamReader reader,
 UnmarshallingContext context,
 Object current)

Read a bare item of the collection from the reader.

Parameters:

reader - the source reader

context - the unmarshalling context

current - the target collection (if already available)

Returns:

the read item

Since:

1.4.11

readCompleteItem

protected Object readCompleteItem(HierarchicalStreamReader reader,
 UnmarshallingContext context,
 Object current)

Read an item of the collection including the tags from the reader.

Parameters:

reader - the source reader

context - the unmarshalling context

current - the target collection (if already available)

Returns:

the read item

Since:

1.4.11

createCollection

protected Object createCollection(Class type)