com.thoughtworks.xstream.converters.extended

Class NamedCollectionConverter

java.lang.Object

com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter

com.thoughtworks.xstream.converters.collections.CollectionConverter

com.thoughtworks.xstream.converters.extended.NamedCollectionConverter

All Implemented Interfaces:

Converter, ConverterMatcher

public class NamedCollectionConverter
extends CollectionConverter

A collection converter that uses predefined names for its items.

To be used as local converter. Note, suppress the usage of the implicit type argument, if registered with annotation.

Since:

1.4.5

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name
private java.lang.Class	type

Constructor Summary

Constructors

Constructor and Description
NamedCollectionConverter(java.lang.Class type, Mapper mapper, java.lang.String itemName, java.lang.Class itemType) Constructs a NamedCollectionConverter handling an explicit Collection type.
NamedCollectionConverter(Mapper mapper, java.lang.String itemName, java.lang.Class itemType) Constructs a NamedCollectionConverter.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	readItem(HierarchicalStreamReader reader, UnmarshallingContext context, java.lang.Object current)
protected void	writeItem(java.lang.Object item, MarshallingContext context, HierarchicalStreamWriter writer)

Methods inherited from class com.thoughtworks.xstream.converters.collections.CollectionConverter

addCurrentElementToCollection, canConvert, createCollection, marshal, populateCollection, populateCollection, unmarshal

Methods inherited from class com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter

mapper

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

type

private final java.lang.Class type

Constructor Detail

NamedCollectionConverter

public NamedCollectionConverter(Mapper mapper,
                                java.lang.String itemName,
                                java.lang.Class itemType)

Constructs a NamedCollectionConverter.

Parameters:

mapper - the mapper

itemName - the name of the items

itemType - the base type of the items

Since:

1.4.5

NamedCollectionConverter

public NamedCollectionConverter(java.lang.Class type,
                                Mapper mapper,
                                java.lang.String itemName,
                                java.lang.Class itemType)

Constructs a NamedCollectionConverter handling an explicit Collection type.

Parameters:

type - the Collection type to handle

mapper - the mapper

itemName - the name of the items

itemType - the base type of the items

Since:

1.4.5

Method Detail

writeItem

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

Overrides:

writeItem in class AbstractCollectionConverter

readItem

protected java.lang.Object readItem(HierarchicalStreamReader reader,
                                    UnmarshallingContext context,
                                    java.lang.Object current)

Overrides:

readItem in class AbstractCollectionConverter