com.thoughtworks.xstream.core

Class AbstractReferenceMarshaller

java.lang.Object

com.thoughtworks.xstream.core.TreeMarshaller

com.thoughtworks.xstream.core.AbstractReferenceMarshaller

All Implemented Interfaces:

DataHolder, MarshallingContext

Direct Known Subclasses:

ReferenceByIdMarshaller, ReferenceByXPathMarshaller

public abstract class AbstractReferenceMarshaller
extends TreeMarshaller
implements MarshallingContext

Abstract base class for a TreeMarshaller, that can build references.

Since:

1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractReferenceMarshaller.Id
static class	AbstractReferenceMarshaller.ReferencedImplicitElementException

Nested classes/interfaces inherited from class com.thoughtworks.xstream.core.TreeMarshaller

TreeMarshaller.CircularReferenceException

Field Summary

Fields

Modifier and Type	Field and Description
private ObjectIdDictionary	implicitElements
private Path	lastPath
private PathTracker	pathTracker
private ObjectIdDictionary	references

Fields inherited from class com.thoughtworks.xstream.core.TreeMarshaller

converterLookup, writer

Constructor Summary

Constructors

Constructor and Description
AbstractReferenceMarshaller(HierarchicalStreamWriter writer, ConverterLookup converterLookup, Mapper mapper)

Method Summary

Modifier and Type	Method and Description
void	convert(java.lang.Object item, Converter converter)
protected abstract java.lang.String	createReference(Path currentPath, java.lang.Object existingReferenceKey)
protected abstract java.lang.Object	createReferenceKey(Path currentPath, java.lang.Object item)
protected abstract void	fireValidReference(java.lang.Object referenceKey)

Methods inherited from class com.thoughtworks.xstream.core.TreeMarshaller

convertAnother, convertAnother, get, getMapper, keys, put, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thoughtworks.xstream.converters.MarshallingContext

convertAnother, convertAnother

Methods inherited from interface com.thoughtworks.xstream.converters.DataHolder

get, keys, put

Field Detail

references

private ObjectIdDictionary references

implicitElements

private ObjectIdDictionary implicitElements

pathTracker

private PathTracker pathTracker

lastPath

private Path lastPath

Constructor Detail

AbstractReferenceMarshaller

public AbstractReferenceMarshaller(HierarchicalStreamWriter writer,
                                   ConverterLookup converterLookup,
                                   Mapper mapper)

Method Detail

convert

public void convert(java.lang.Object item,
                    Converter converter)

Overrides:

convert in class TreeMarshaller

createReference

protected abstract java.lang.String createReference(Path currentPath,
                                                    java.lang.Object existingReferenceKey)

createReferenceKey

protected abstract java.lang.Object createReferenceKey(Path currentPath,
                                                       java.lang.Object item)

fireValidReference

protected abstract void fireValidReference(java.lang.Object referenceKey)