XStream Core 1.4.20 · com.thoughtworks.xstream.mapper.Mapper

Modifier and Type	Class and Description
public static interface	Mapper.ImplicitCollectionMapping
public static class	Mapper.Null Place holder type used for null values.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the alias aliasForAttribute(String the attribute attribute) Get the alias for an attribute's name.
public String	Returns: the alias for this field or its own name if no alias was defined aliasForAttribute(Class<T> the type where the field was defined definedIn, String the field name fieldName) Deprecated As of 1.3, use combination of `serializedMember(Class, String)` and `getConverterFromItemType(String, Class, Class)` Returns an alias for a single field defined in an specific type.
public String	Returns: the alias aliasForSystemAttribute(String the system attribute attribute) Get the alias for a system attribute's name.
public String	Returns: the attribute's name attributeForAlias(String the alias alias) Get the attribute's name for an alias.
public String	Returns: the original attribute name attributeForAlias(Class<T> the type where the field was defined definedIn, String the alias alias) Deprecated As of 1.3, use combination of `realMember(Class, String)` and `getConverterFromItemType(String, Class, Class)` Returns the field name for an aliased attribute.
public Class<T>	defaultImplementationOf(Class<T> type)
public SingleValueConverter	getConverterFromAttribute(String name) Deprecated As of 1.3, use `getConverterFromAttribute(Class, String, Class)`
public SingleValueConverter	getConverterFromAttribute(Class<T> the field's parent definedIn, String the attribute name attribute) Deprecated As of 1.3.1, use `getConverterFromAttribute(Class, String, Class)` Returns which converter to use for an specific attribute in a type.
public SingleValueConverter	getConverterFromAttribute(Class<T> the field's parent definedIn, String the attribute name attribute, Class<T> the type the converter should create type) Returns which converter to use for an specific attribute in a type.
public SingleValueConverter	getConverterFromItemType(String fieldName, Class<T> type) Deprecated As of 1.3, use `getConverterFromItemType(String, Class, Class)`
public SingleValueConverter	getConverterFromItemType(Class<T> type) Deprecated As of 1.3, use `getConverterFromItemType(String, Class, Class)`
public SingleValueConverter	Returns: a SingleValueConverter or null if there no such converter should be used for this field. getConverterFromItemType(String the field name fieldName, Class<T> the field type type, Class<T> the type which defines this field definedIn) Returns a single value converter to be used in a specific field.
public String	getFieldNameForItemTypeAndName(Class<T> owning type definedIn, Class<T> item type itemType, String optional item element name itemFieldName) Get the name of the field that acts as the default collection for an object, or return null if there is none.
public Mapper.ImplicitCollectionMapping	getImplicitCollectionDefForFieldName(Class<T> itemType, String fieldName)
public Class<T>	getItemTypeForItemFieldName(Class<T> definedIn, String itemFieldName)
public Converter	getLocalConverter(Class<T> definedIn, String fieldName)
public boolean	isIgnoredElement(String name) Whether this name can be ignored.
public boolean	isImmutableValueType(Class<T> type) Whether this type is a simple immutable value (int, boolean, String, URL, etc).
public boolean	isReferenceable(Class<T> type) Whether this type is referenceable in a stream.
public Mapper	lookupMapperOfType(Class<T> type)
public Class<T>	realClass(String elementName) How a serialized class representation should be mapped back to a real class.
public String	realMember(Class<T> type, String serialized) How a serialized member representation should be mapped back to a real member.
public String	serializedClass(Class<T> type) How a class name should be represented in its serialized form.
public String	serializedMember(Class<T> type, String memberName) How a class member should be represented in its serialized form.
public boolean	shouldSerializeMember(Class<T> definedIn, String fieldName) Determine whether a specific member should be serialized.

Method Detail

aliasForAttribute	back to summary
public String aliasForAttribute(String attribute) Get the alias for an attribute's name. Parameters attribute:String the attribute Returns:String the alias Since 1.2

aliasForAttribute

back to summary

public String aliasForAttribute(String attribute)

Get the alias for an attribute's name.

Parameters

attribute:String: the attribute

Returns:String

the alias

Since

1.2

aliasForAttribute back to summary

aliasForAttribute	back to summary
public String aliasForAttribute(Class<T> definedIn, String fieldName) Deprecated As of 1.3, use combination of `serializedMember(Class, String)` and `getConverterFromItemType(String, Class, Class)` Returns an alias for a single field defined in an specific type. Parameters definedIn:Class<T> the type where the field was defined fieldName:String the field name Returns:String the alias for this field or its own name if no alias was defined Since 1.2.2

public String aliasForAttribute(Class<T> definedIn, String fieldName)

Deprecated

As of 1.3, use combination of serializedMember(Class, String) and getConverterFromItemType(String, Class, Class)

Returns an alias for a single field defined in an specific type.

Parameters

definedIn:Class<T>: the type where the field was defined
fieldName:String: the field name

Returns:String

the alias for this field or its own name if no alias was defined

Since

1.2.2

aliasForSystemAttribute	back to summary
public String aliasForSystemAttribute(String attribute) Get the alias for a system attribute's name. Parameters attribute:String the system attribute Returns:String the alias Since 1.3.1

aliasForSystemAttribute

back to summary

public String aliasForSystemAttribute(String attribute)

Get the alias for a system attribute's name.

Parameters

attribute:String: the system attribute

Returns:String

the alias

Since

1.3.1

attributeForAlias	back to summary
public String attributeForAlias(String alias) Get the attribute's name for an alias. Parameters alias:String the alias Returns:String the attribute's name Since 1.2

attributeForAlias

back to summary

public String attributeForAlias(String alias)

Get the attribute's name for an alias.

Parameters

alias:String: the alias

Returns:String

the attribute's name

Since

1.2

attributeForAlias back to summary

attributeForAlias	back to summary
public String attributeForAlias(Class<T> definedIn, String alias) Deprecated As of 1.3, use combination of `realMember(Class, String)` and `getConverterFromItemType(String, Class, Class)` Returns the field name for an aliased attribute. Parameters definedIn:Class<T> the type where the field was defined alias:String the alias Returns:String the original attribute name Since 1.2.2

public String attributeForAlias(Class<T> definedIn, String alias)

Deprecated

As of 1.3, use combination of realMember(Class, String) and getConverterFromItemType(String, Class, Class)

Returns the field name for an aliased attribute.

Parameters

definedIn:Class<T>: the type where the field was defined
alias:String: the alias

Returns:String

the original attribute name

Since

1.2.2

defaultImplementationOf	back to summary
public Class<T> defaultImplementationOf(Class<T> type)

getConverterFromAttribute	back to summary
public SingleValueConverter getConverterFromAttribute(String name) Deprecated As of 1.3, use `getConverterFromAttribute(Class, String, Class)`

getConverterFromAttribute back to summary

getConverterFromAttribute	back to summary
public SingleValueConverter getConverterFromAttribute(Class<T> definedIn, String attribute) Deprecated As of 1.3.1, use `getConverterFromAttribute(Class, String, Class)` Returns which converter to use for an specific attribute in a type. Parameters definedIn:Class<T> the field's parent attribute:String the attribute name

public SingleValueConverter getConverterFromAttribute(Class<T> definedIn, String attribute)

Deprecated

As of 1.3.1, use getConverterFromAttribute(Class, String, Class)

Returns which converter to use for an specific attribute in a type.

Parameters

definedIn:Class<T>: the field's parent
attribute:String: the attribute name

getConverterFromAttribute	back to summary
public SingleValueConverter getConverterFromAttribute(Class<T> definedIn, String attribute, Class<T> type) Returns which converter to use for an specific attribute in a type. Parameters definedIn:Class<T> the field's parent attribute:String the attribute name type:Class<T> the type the converter should create Since 1.3.1

getConverterFromAttribute

back to summary

public SingleValueConverter getConverterFromAttribute(Class<T> definedIn, String attribute, Class<T> type)

Returns which converter to use for an specific attribute in a type.

Parameters

definedIn:Class<T>: the field's parent
attribute:String: the attribute name
type:Class<T>: the type the converter should create

Since

1.3.1

getConverterFromItemType	back to summary
public SingleValueConverter getConverterFromItemType(String fieldName, Class<T> type) Deprecated As of 1.3, use `getConverterFromItemType(String, Class, Class)`

getConverterFromItemType	back to summary
public SingleValueConverter getConverterFromItemType(Class<T> type) Deprecated As of 1.3, use `getConverterFromItemType(String, Class, Class)`

getConverterFromItemType	back to summary
public SingleValueConverter getConverterFromItemType(String fieldName, Class<T> type, Class<T> definedIn) Returns a single value converter to be used in a specific field. Parameters fieldName:String the field name type:Class<T> the field type definedIn:Class<T> the type which defines this field Returns:SingleValueConverter a SingleValueConverter or null if there no such converter should be used for this field. Since 1.2.2

getConverterFromItemType

back to summary

public SingleValueConverter getConverterFromItemType(String fieldName, Class<T> type, Class<T> definedIn)

Returns a single value converter to be used in a specific field.

Parameters

fieldName:String: the field name
type:Class<T>: the field type
definedIn:Class<T>: the type which defines this field

Returns:SingleValueConverter

a SingleValueConverter or null if there no such converter should be used for this field.

Since

1.2.2

getFieldNameForItemTypeAndName	back to summary
public String getFieldNameForItemTypeAndName(Class<T> definedIn, Class<T> itemType, String itemFieldName) Get the name of the field that acts as the default collection for an object, or return null if there is none. Parameters definedIn:Class<T> owning type itemType:Class<T> item type itemFieldName:String optional item element name

getFieldNameForItemTypeAndName

back to summary

public String getFieldNameForItemTypeAndName(Class<T> definedIn, Class<T> itemType, String itemFieldName)

Get the name of the field that acts as the default collection for an object, or return null if there is none.

Parameters

definedIn:Class<T>: owning type
itemType:Class<T>: item type
itemFieldName:String: optional item element name

getImplicitCollectionDefForFieldName	back to summary
public Mapper.ImplicitCollectionMapping getImplicitCollectionDefForFieldName(Class<T> itemType, String fieldName)

getItemTypeForItemFieldName	back to summary
public Class<T> getItemTypeForItemFieldName(Class<T> definedIn, String itemFieldName)

getLocalConverter	back to summary
public Converter getLocalConverter(Class<T> definedIn, String fieldName)

isIgnoredElement	back to summary
public boolean isIgnoredElement(String name) Whether this name can be ignored. Since 1.4.9

isIgnoredElement

back to summary

public boolean isIgnoredElement(String name)

Whether this name can be ignored.

Since: 1.4.9

isImmutableValueType	back to summary
public boolean isImmutableValueType(Class<T> type) Whether this type is a simple immutable value (int, boolean, String, URL, etc). Immutable types will be repeatedly written in the serialized stream, instead of using object references.

isReferenceable	back to summary
public boolean isReferenceable(Class<T> type) Whether this type is referenceable in a stream. Since 1.4.9

isReferenceable

back to summary

public boolean isReferenceable(Class<T> type)

Whether this type is referenceable in a stream.

Since: 1.4.9

lookupMapperOfType	back to summary
public Mapper lookupMapperOfType(Class<T> type)

realClass	back to summary
public Class<T> realClass(String elementName) How a serialized class representation should be mapped back to a real class.

realMember	back to summary
public String realMember(Class<T> type, String serialized) How a serialized member representation should be mapped back to a real member.

serializedClass	back to summary
public String serializedClass(Class<T> type) How a class name should be represented in its serialized form.

serializedMember	back to summary
public String serializedMember(Class<T> type, String memberName) How a class member should be represented in its serialized form.

shouldSerializeMember	back to summary
public boolean shouldSerializeMember(Class<T> definedIn, String fieldName) Determine whether a specific member should be serialized. Since 1.1.3

shouldSerializeMember

back to summary

public boolean shouldSerializeMember(Class<T> definedIn, String fieldName)

Determine whether a specific member should be serialized.

Since: 1.1.3

public Interface Mapper

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface Mapper.ImplicitCollectionMapping

Method Summary

Method Detail

public Class Mapper.Null

Constructor Summary

Method Summary

Constructor Detail

Modifier and Type	Method and Description
public String	getFieldName()
public String	getItemFieldName()
public Class<T>	getItemType()
public String	getKeyFieldName()