com.thoughtworks.xstream.converters.collections
Class CollectionConverter

java.lang.Object
  extended by com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter
      extended by com.thoughtworks.xstream.converters.collections.CollectionConverter
All Implemented Interfaces:
Converter, ConverterMatcher
Direct Known Subclasses:
SingletonCollectionConverter, TreeSetConverter

public class CollectionConverter
extends AbstractCollectionConverter

Converts most common Collections (Lists and Sets) to XML, specifying a nested element for each item.

Supports java.util.ArrayList, java.util.HashSet, java.util.LinkedList, java.util.Vector and java.util.LinkedHashSet.

Author:
Joe Walnes

Constructor Summary
CollectionConverter(Mapper mapper)
           
 
Method Summary
protected  void addCurrentElementToCollection(HierarchicalStreamReader reader, UnmarshallingContext context, Collection collection, Collection target)
           
 boolean canConvert(Class type)
          Determines whether the converter can marshall a particular type.
 void marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context)
          Convert an object to textual data.
protected  void populateCollection(HierarchicalStreamReader reader, UnmarshallingContext context, Collection collection)
           
protected  void populateCollection(HierarchicalStreamReader reader, UnmarshallingContext context, Collection collection, Collection target)
           
 Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context)
          Convert textual data back into an object.
 
Methods inherited from class com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter
createCollection, mapper, readItem, writeItem
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CollectionConverter

public CollectionConverter(Mapper mapper)
Method Detail

canConvert

public boolean canConvert(Class type)
Description copied from interface: ConverterMatcher
Determines whether the converter can marshall a particular type.

Specified by:
canConvert in interface ConverterMatcher
Specified by:
canConvert in class AbstractCollectionConverter
Parameters:
type - the Class representing the object type to be converted

marshal

public 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
Specified by:
marshal in class AbstractCollectionConverter
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 Object unmarshal(HierarchicalStreamReader reader,
                        UnmarshallingContext context)
Description copied from interface: Converter
Convert textual data back into an object.

Specified by:
unmarshal in interface Converter
Specified by:
unmarshal in class AbstractCollectionConverter
Parameters:
reader - The stream to read the text from.
Returns:
The resulting object.

populateCollection

protected void populateCollection(HierarchicalStreamReader reader,
                                  UnmarshallingContext context,
                                  Collection collection)

populateCollection

protected void populateCollection(HierarchicalStreamReader reader,
                                  UnmarshallingContext context,
                                  Collection collection,
                                  Collection target)

addCurrentElementToCollection

protected void addCurrentElementToCollection(HierarchicalStreamReader reader,
                                             UnmarshallingContext context,
                                             Collection collection,
                                             Collection target)


Copyright © 2004-2014 XStream. All Rights Reserved.