com.thoughtworks.xstream.mapper

Class FieldAliasingMapper

java.lang.Object

com.thoughtworks.xstream.mapper.MapperWrapper

com.thoughtworks.xstream.mapper.FieldAliasingMapper

All Implemented Interfaces:

com.thoughtworks.xstream.mapper.Mapper

public class FieldAliasingMapper
extends com.thoughtworks.xstream.mapper.MapperWrapper

Mapper that allows a field of a specific class to be replaced with a shorter alias, or omitted entirely.

Author:

Joe Walnes

Nested Class Summary

Nested classes/interfaces inherited from interface com.thoughtworks.xstream.mapper.Mapper

com.thoughtworks.xstream.mapper.Mapper.ImplicitCollectionMapping, com.thoughtworks.xstream.mapper.Mapper.Null

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	aliasToFieldMap
protected java.util.Set	fieldsToOmit
protected java.util.Map	fieldToAliasMap
protected java.util.Set	unknownFieldsToIgnore

Constructor Summary

Constructors

Constructor and Description
FieldAliasingMapper(com.thoughtworks.xstream.mapper.Mapper wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFieldAlias(java.lang.String alias, java.lang.Class type, java.lang.String fieldName)
void	addFieldsToIgnore(java.util.regex.Pattern pattern)
void	omitField(java.lang.Class definedIn, java.lang.String fieldName)
java.lang.String	realMember(java.lang.Class type, java.lang.String serialized)
java.lang.String	serializedMember(java.lang.Class type, java.lang.String memberName)
boolean	shouldSerializeMember(java.lang.Class definedIn, java.lang.String fieldName)

Methods inherited from class com.thoughtworks.xstream.mapper.MapperWrapper

aliasForAttribute, aliasForAttribute, aliasForSystemAttribute, attributeForAlias, attributeForAlias, defaultImplementationOf, getConverterFromAttribute, getConverterFromAttribute, getConverterFromAttribute, getConverterFromItemType, getConverterFromItemType, getConverterFromItemType, getFieldNameForItemTypeAndName, getImplicitCollectionDefForFieldName, getItemTypeForItemFieldName, getLocalConverter, isImmutableValueType, lookupMapperOfType, realClass, serializedClass

Methods inherited from class java.lang.Object

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

Field Detail

fieldToAliasMap

protected final java.util.Map fieldToAliasMap

aliasToFieldMap

protected final java.util.Map aliasToFieldMap

fieldsToOmit

protected final java.util.Set fieldsToOmit

unknownFieldsToIgnore

protected final java.util.Set unknownFieldsToIgnore

Constructor Detail

FieldAliasingMapper

public FieldAliasingMapper(com.thoughtworks.xstream.mapper.Mapper wrapped)

Method Detail

addFieldAlias

public void addFieldAlias(java.lang.String alias,
                 java.lang.Class type,
                 java.lang.String fieldName)

addFieldsToIgnore

public void addFieldsToIgnore(java.util.regex.Pattern pattern)

serializedMember

public java.lang.String serializedMember(java.lang.Class type,
                                java.lang.String memberName)

Specified by:

serializedMember in interface com.thoughtworks.xstream.mapper.Mapper

Overrides:

serializedMember in class com.thoughtworks.xstream.mapper.MapperWrapper

realMember

public java.lang.String realMember(java.lang.Class type,
                          java.lang.String serialized)

Specified by:

realMember in interface com.thoughtworks.xstream.mapper.Mapper

Overrides:

realMember in class com.thoughtworks.xstream.mapper.MapperWrapper

shouldSerializeMember

public boolean shouldSerializeMember(java.lang.Class definedIn,
                            java.lang.String fieldName)

Specified by:

shouldSerializeMember in interface com.thoughtworks.xstream.mapper.Mapper

Overrides:

shouldSerializeMember in class com.thoughtworks.xstream.mapper.MapperWrapper

omitField

public void omitField(java.lang.Class definedIn,
             java.lang.String fieldName)