Class ElementIgnoringMapper

java.lang.Object

com.thoughtworks.xstream.mapper.MapperWrapper

com.thoughtworks.xstream.mapper.ElementIgnoringMapper

All Implemented Interfaces:

Mapper

public class ElementIgnoringMapper
extends MapperWrapper

Mapper that allows an field of a specific class to be omitted entirely.

Nested Class Summary

Nested classes/interfaces inherited from interface Mapper

Mapper.ImplicitCollectionMapping, Mapper.Null

Field Summary

Fields

Modifier and Type	Field	Description
private final MemberDictionary	fieldsToOmit
private final Map	unknownElementsToIgnore

Constructor Summary

Constructors

Constructor	Description
ElementIgnoringMapper(Mapper wrapped)

Method Summary

Modifier and Type	Method	Description
void	addElementsToIgnore(Pattern pattern)
boolean	isIgnoredElement(String name)	Whether this name can be ignored.
void	omitField(Class definedIn, String fieldName)
boolean	shouldSerializeMember(Class definedIn, String fieldName)	Determine whether a specific member should be serialized.

Methods inherited from class MapperWrapper

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

Methods inherited from class Object

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

Field Details

fieldsToOmit

private final MemberDictionary fieldsToOmit

unknownElementsToIgnore

private final Map unknownElementsToIgnore

Constructor Details

ElementIgnoringMapper

public ElementIgnoringMapper(Mapper wrapped)

Method Details

addElementsToIgnore

public void addElementsToIgnore(Pattern pattern)

omitField

public void omitField(Class definedIn,
 String fieldName)

shouldSerializeMember

public boolean shouldSerializeMember(Class definedIn,
 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

isIgnoredElement

public boolean isIgnoredElement(String name)

Description copied from interface: Mapper

Whether this name can be ignored.

Specified by:

isIgnoredElement in interface Mapper

Overrides:

isIgnoredElement in class MapperWrapper