com.thoughtworks.xstream.mapper
Class FieldAliasingMapper

java.lang.Object
  extended by com.thoughtworks.xstream.mapper.MapperWrapper
      extended by com.thoughtworks.xstream.mapper.FieldAliasingMapper
All Implemented Interfaces:
Mapper

public class FieldAliasingMapper
extends 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
Mapper.ImplicitCollectionMapping, Mapper.Null
 
Field Summary
protected  java.util.Map aliasToFieldMap
           
protected  java.util.Set fieldsToOmit
           
protected  java.util.Map fieldToAliasMap
           
 
Constructor Summary
FieldAliasingMapper(ClassMapper wrapped)
          Deprecated. As of 1.2, use FieldAliasingMapper(Mapper)
FieldAliasingMapper(Mapper wrapped)
           
 
Method Summary
 void addFieldAlias(java.lang.String alias, java.lang.Class type, java.lang.String fieldName)
           
 void omitField(java.lang.Class type, java.lang.String fieldName)
           
 java.lang.String realMember(java.lang.Class type, java.lang.String serialized)
          How a serialized member representation should be mapped back to a real member.
 java.lang.String serializedMember(java.lang.Class type, java.lang.String memberName)
          How a class member should be represented in its serialized form.
 boolean shouldSerializeMember(java.lang.Class definedIn, java.lang.String fieldName)
          Determine whether a specific member should be serialized.
 
Methods inherited from class com.thoughtworks.xstream.mapper.MapperWrapper
aliasForAttribute, aliasForAttribute, attributeForAlias, attributeForAlias, attributeForClassDefiningField, attributeForEnumType, attributeForImplementationClass, attributeForReadResolveField, defaultImplementationOf, getConverterFromAttribute, getConverterFromAttribute, getConverterFromItemType, getConverterFromItemType, getConverterFromItemType, getFieldNameForItemTypeAndName, getImplicitCollectionDefForFieldName, getItemTypeForItemFieldName, 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
Constructor Detail

FieldAliasingMapper

public FieldAliasingMapper(Mapper wrapped)

FieldAliasingMapper

public FieldAliasingMapper(ClassMapper wrapped)
Deprecated. As of 1.2, use FieldAliasingMapper(Mapper)

Method Detail

addFieldAlias

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

serializedMember

public java.lang.String serializedMember(java.lang.Class type,
                                         java.lang.String memberName)
Description copied from interface: Mapper
How a class member should be represented in its serialized form.

Specified by:
serializedMember in interface Mapper
Overrides:
serializedMember in class MapperWrapper

realMember

public java.lang.String realMember(java.lang.Class type,
                                   java.lang.String serialized)
Description copied from interface: Mapper
How a serialized member representation should be mapped back to a real member.

Specified by:
realMember in interface Mapper
Overrides:
realMember in class MapperWrapper

shouldSerializeMember

public boolean shouldSerializeMember(java.lang.Class definedIn,
                                     java.lang.String fieldName)
Description copied from interface: Mapper
Determine whether a specific member should be serialized.

Specified by:
shouldSerializeMember in interface Mapper
Overrides:
shouldSerializeMember in class MapperWrapper

omitField

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


Joe Walnes, http://xstream.codehaus.org/