Class NamedMapConverter

java.lang.Object

com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter

com.thoughtworks.xstream.converters.collections.MapConverter

com.thoughtworks.xstream.converters.extended.NamedMapConverter

All Implemented Interfaces:

Converter, ConverterMatcher

public class NamedMapConverter
extends MapConverter

A map converter that uses predefined names for its elements.

To be used as local converter. Note, suppress the usage of the implicit type argument, if registered with annotation. Depending on the constructor arguments it is possible to support various formats:

• new NamedMapConverter(xstream.getMapper(), "entry", "key", String.class, "value", Integer.class);

  <map>
    <entry>
      <key>keyValue</key>
      <value>0</value>
    </entry>
  </map>
  

• new NamedMapConverter(xstream.getMapper(), null, "key", String.class, "value", Integer.class);

  <map>
    <key>keyValue</key>
    <value>0</value>
  </map>
  

• new NamedMapConverter(xstream.getMapper(), "entry", "key", String.class, "value", Integer.class, true, true, xstream.getConverterLookup());

  <map>
    <entry> key="keyValue" value="0"/>
  </map>
  

• new NamedMapConverter(xstream.getMapper(), "entry", "key", String.class, "value", Integer.class, true, false, xstream.getConverterLookup());

  <map>
    <entry key="keyValue">
      <value>0</value>
    </entry>
  </map>
  

• new NamedMapConverter(xstream.getMapper(), "entry", "key", String.class, "value", Integer.class, false, true, xstream.getConverterLookup());

  <map>
    <entry value="0">
      <key>keyValue</key>
    </entry>
  </map>
  

• new NamedMapConverter(xstream.getMapper(), "entry", "key", String.class, null, Integer.class, true, false, xstream.getConverterLookup());

  <map>
    <entry key="keyValue">0</entry>
  </map>
  

Since:

1.4.5

Author:

Jörg Schaible

Constructor Summary

Constructors

Constructor	Description
NamedMapConverter(Mapper mapper, String entryName, String keyName, Class keyType, String valueName, Class valueType)	Constructs a NamedMapConverter.
NamedMapConverter(Mapper mapper, String entryName, String keyName, Class keyType, String valueName, Class valueType, boolean keyAsAttribute, boolean valueAsAttribute, ConverterLookup lookup)	Constructs a NamedMapConverter with attribute support.
NamedMapConverter(Class type, Mapper mapper, String entryName, String keyName, Class keyType, String valueName, Class valueType)	Constructs a NamedMapConverter handling an explicit Map type.
NamedMapConverter(Class type, Mapper mapper, String entryName, String keyName, Class keyType, String valueName, Class valueType, boolean keyAsAttribute, boolean valueAsAttribute, ConverterLookup lookup)	Constructs a NamedMapConverter with attribute support handling an explicit Map type.

Method Summary

Modifier and Type	Method	Description
void	marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context)	Convert an object to textual data.
protected void	populateMap(HierarchicalStreamReader reader, UnmarshallingContext context, Map map, Map target)
protected Object	readItem(Class type, HierarchicalStreamReader reader, UnmarshallingContext context, Object current)
protected void	writeItem(String name, Class type, Object item, MarshallingContext context, HierarchicalStreamWriter writer)

Methods inherited from class MapConverter

canConvert, createCollection, populateMap, putCurrentEntryIntoMap, unmarshal

Methods inherited from class AbstractCollectionConverter

mapper, readBareItem, readCompleteItem, readItem, writeBareItem, writeCompleteItem, writeItem, writeNullItem

Methods inherited from class Object

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

Constructor Details

NamedMapConverter

public NamedMapConverter(Mapper mapper,
 String entryName,
 String keyName,
 Class keyType,
 String valueName,
 Class valueType)

Constructs a NamedMapConverter.

Parameters:

mapper - the mapper

entryName - the name of the entry elements

keyName - the name of the key elements

keyType - the base type of key elements

valueName - the name of the value elements

valueType - the base type of value elements

Since:

1.4.5

NamedMapConverter

public NamedMapConverter(Class type,
 Mapper mapper,
 String entryName,
 String keyName,
 Class keyType,
 String valueName,
 Class valueType)

Constructs a NamedMapConverter handling an explicit Map type.

Parameters:

type - the Map type this instance will handle

mapper - the mapper

entryName - the name of the entry elements

keyName - the name of the key elements

keyType - the base type of key elements

valueName - the name of the value elements

valueType - the base type of value elements

Since:

1.4.5

NamedMapConverter

public NamedMapConverter(Mapper mapper,
 String entryName,
 String keyName,
 Class keyType,
 String valueName,
 Class valueType,
 boolean keyAsAttribute,
 boolean valueAsAttribute,
 ConverterLookup lookup)

Constructs a NamedMapConverter with attribute support.

Parameters:

mapper - the mapper

entryName - the name of the entry elements

keyName - the name of the key elements

keyType - the base type of key elements

valueName - the name of the value elements

valueType - the base type of value elements

keyAsAttribute - flag to write key as attribute of entry element

valueAsAttribute - flag to write value as attribute of entry element

lookup - used to lookup SingleValueConverter for attributes

Since:

1.4.5

NamedMapConverter

public NamedMapConverter(Class type,
 Mapper mapper,
 String entryName,
 String keyName,
 Class keyType,
 String valueName,
 Class valueType,
 boolean keyAsAttribute,
 boolean valueAsAttribute,
 ConverterLookup lookup)

Constructs a NamedMapConverter with attribute support handling an explicit Map type.

Parameters:

type - the Map type this instance will handle

mapper - the mapper

entryName - the name of the entry elements

keyName - the name of the key elements

keyType - the base type of key elements

valueName - the name of the value elements

valueType - the base type of value elements

keyAsAttribute - flag to write key as attribute of entry element

valueAsAttribute - flag to write value as attribute of entry element

lookup - used to lookup SingleValueConverter for attributes

Since:

1.4.5

Method Details

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

Overrides:

marshal in class MapConverter

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.

populateMap

protected void populateMap(HierarchicalStreamReader reader,
 UnmarshallingContext context,
 Map map,
 Map target)

Overrides:

populateMap in class MapConverter

writeItem

protected void writeItem(String name,
 Class type,
 Object item,
 MarshallingContext context,
 HierarchicalStreamWriter writer)

readItem

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