XStream Core 1.4.20 · com.thoughtworks.xstream.converters.extended.NamedMapConverter

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>
```

Modifier and Type	Field and Description
private final String	entryName
private final Mapper	enumMapper
private final boolean	keyAsAttribute
private final String	keyName
private final Class<T>	keyType
private final ConverterLookup	lookup
private final boolean	valueAsAttribute
private final String	valueName
private final Class<T>	valueType

Constructor Summary

Access	Constructor and Description
public	NamedMapConverter(Mapper the mapper mapper, String the name of the entry elements entryName, String the name of the key elements keyName, Class<T> the base type of key elements keyType, String the name of the value elements valueName, Class<T> the base type of value elements valueType) Constructs a NamedMapConverter.
public	NamedMapConverter(Class<T> the Map type this instance will handle type, Mapper the mapper mapper, String the name of the entry elements entryName, String the name of the key elements keyName, Class<T> the base type of key elements keyType, String the name of the value elements valueName, Class<T> the base type of value elements valueType) Constructs a NamedMapConverter handling an explicit Map type.
public	NamedMapConverter(Mapper the mapper mapper, String the name of the entry elements entryName, String the name of the key elements keyName, Class<T> the base type of key elements keyType, String the name of the value elements valueName, Class<T> the base type of value elements valueType, boolean flag to write key as attribute of entry element keyAsAttribute, boolean flag to write value as attribute of entry element valueAsAttribute, ConverterLookup used to lookup SingleValueConverter for attributes lookup) Constructs a NamedMapConverter with attribute support.
public	NamedMapConverter(Class<T> the Map type this instance will handle type, Mapper the mapper mapper, String the name of the entry elements entryName, String the name of the key elements keyName, Class<T> the base type of key elements keyType, String the name of the value elements valueName, Class<T> the base type of value elements valueType, boolean flag to write key as attribute of entry element keyAsAttribute, boolean flag to write value as attribute of entry element valueAsAttribute, ConverterLookup used to lookup SingleValueConverter for attributes lookup) Constructs a NamedMapConverter with attribute support handling an explicit Map type.

Method Summary

Modifier and Type	Method and Description
private SingleValueConverter	getSingleValueConverter(Class<T> type, String part)
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) Overrides com.thoughtworks.xstream.converters.collections.MapConverter.marshal. Implements com.thoughtworks.xstream.converters.Converter.marshal. Convert an object to textual data.
protected void	populateMap(HierarchicalStreamReader reader, UnmarshallingContext context, Map<K, V> map, Map<K, V> target) Overrides com.thoughtworks.xstream.converters.collections.MapConverter.populateMap.
protected Object	readItem(Class<T> type, HierarchicalStreamReader reader, UnmarshallingContext context, Object current)
protected void	writeItem(String name, Class<T> type, Object item, MarshallingContext context, HierarchicalStreamWriter writer)

Inherited from com.thoughtworks.xstream.converters.collections.MapConverter:: canConvert createCollection populateMap putCurrentEntryIntoMap unmarshal

Field Detail

entryName	back to summary
private final String entryName

enumMapper	back to summary
private final Mapper enumMapper

keyAsAttribute	back to summary
private final boolean keyAsAttribute

keyName	back to summary
private final String keyName

keyType	back to summary
private final Class<T> keyType

lookup	back to summary
private final ConverterLookup lookup

valueAsAttribute	back to summary
private final boolean valueAsAttribute

valueName	back to summary
private final String valueName

valueType	back to summary
private final Class<T> valueType

Constructor Detail

NamedMapConverter	back to summary
public NamedMapConverter(Mapper mapper, String entryName, String keyName, Class<T> keyType, String valueName, Class<T> valueType) Constructs a NamedMapConverter. Parameters mapper:Mapper the mapper entryName:String the name of the entry elements keyName:String the name of the key elements keyType:Class<T> the base type of key elements valueName:String the name of the value elements valueType:Class<T> the base type of value elements Since 1.4.5

NamedMapConverter

back to summary

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

Constructs a NamedMapConverter.

Parameters

mapper:Mapper: the mapper
entryName:String: the name of the entry elements
keyName:String: the name of the key elements
keyType:Class<T>: the base type of key elements
valueName:String: the name of the value elements
valueType:Class<T>: the base type of value elements

Since

1.4.5

NamedMapConverter	back to summary
public NamedMapConverter(Class<T> type, Mapper mapper, String entryName, String keyName, Class<T> keyType, String valueName, Class<T> valueType) Constructs a NamedMapConverter handling an explicit Map type. Parameters type:Class<T> the Map type this instance will handle mapper:Mapper the mapper entryName:String the name of the entry elements keyName:String the name of the key elements keyType:Class<T> the base type of key elements valueName:String the name of the value elements valueType:Class<T> the base type of value elements Since 1.4.5

NamedMapConverter

back to summary

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

Constructs a NamedMapConverter handling an explicit Map type.

Parameters

type:Class<T>: the Map type this instance will handle
mapper:Mapper: the mapper
entryName:String: the name of the entry elements
keyName:String: the name of the key elements
keyType:Class<T>: the base type of key elements
valueName:String: the name of the value elements
valueType:Class<T>: the base type of value elements

Since

1.4.5

NamedMapConverter	back to summary
public NamedMapConverter(Mapper mapper, String entryName, String keyName, Class<T> keyType, String valueName, Class<T> valueType, boolean keyAsAttribute, boolean valueAsAttribute, ConverterLookup lookup) Constructs a NamedMapConverter with attribute support. Parameters mapper:Mapper the mapper entryName:String the name of the entry elements keyName:String the name of the key elements keyType:Class<T> the base type of key elements valueName:String the name of the value elements valueType:Class<T> the base type of value elements keyAsAttribute:boolean flag to write key as attribute of entry element valueAsAttribute:boolean flag to write value as attribute of entry element lookup:ConverterLookup used to lookup SingleValueConverter for attributes Since 1.4.5

NamedMapConverter

back to summary

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

Constructs a NamedMapConverter with attribute support.

Parameters

mapper:Mapper: the mapper
entryName:String: the name of the entry elements
keyName:String: the name of the key elements
keyType:Class<T>: the base type of key elements
valueName:String: the name of the value elements
valueType:Class<T>: the base type of value elements
keyAsAttribute:boolean: flag to write key as attribute of entry element
valueAsAttribute:boolean: flag to write value as attribute of entry element
lookup:ConverterLookup: used to lookup SingleValueConverter for attributes

Since

1.4.5

NamedMapConverter	back to summary
public NamedMapConverter(Class<T> type, Mapper mapper, String entryName, String keyName, Class<T> keyType, String valueName, Class<T> valueType, boolean keyAsAttribute, boolean valueAsAttribute, ConverterLookup lookup) Constructs a NamedMapConverter with attribute support handling an explicit Map type. Parameters type:Class<T> the Map type this instance will handle mapper:Mapper the mapper entryName:String the name of the entry elements keyName:String the name of the key elements keyType:Class<T> the base type of key elements valueName:String the name of the value elements valueType:Class<T> the base type of value elements keyAsAttribute:boolean flag to write key as attribute of entry element valueAsAttribute:boolean flag to write value as attribute of entry element lookup:ConverterLookup used to lookup SingleValueConverter for attributes Since 1.4.5

NamedMapConverter

back to summary

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

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

Parameters

type:Class<T>: the Map type this instance will handle
mapper:Mapper: the mapper
entryName:String: the name of the entry elements
keyName:String: the name of the key elements
keyType:Class<T>: the base type of key elements
valueName:String: the name of the value elements
valueType:Class<T>: the base type of value elements
keyAsAttribute:boolean: flag to write key as attribute of entry element
valueAsAttribute:boolean: flag to write value as attribute of entry element
lookup:ConverterLookup: used to lookup SingleValueConverter for attributes

Since

1.4.5

Method Detail

getSingleValueConverter	back to summary
private SingleValueConverter getSingleValueConverter(Class<T> type, String part)

marshal	back to summary
public void marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context) Overrides com.thoughtworks.xstream.converters.collections.MapConverter.marshal. 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.

marshal

back to summary

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

Overrides com.thoughtworks.xstream.converters.collections.MapConverter.marshal.

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.

populateMap	back to summary
protected void populateMap(HierarchicalStreamReader reader, UnmarshallingContext context, Map<K, V> map, Map<K, V> target) Overrides com.thoughtworks.xstream.converters.collections.MapConverter.populateMap.

readItem	back to summary
protected Object readItem(Class<T> type, HierarchicalStreamReader reader, UnmarshallingContext context, Object current)

writeItem	back to summary
protected void writeItem(String name, Class<T> type, Object item, MarshallingContext context, HierarchicalStreamWriter writer)

public Class NamedMapConverter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail