com.atlassian.confluence.diff.marshallers

Class DiffInlineTaskMarshaller

java.lang.Object

com.atlassian.confluence.diff.marshallers.DiffInlineTaskMarshaller

All Implemented Interfaces:

Marshaller<InlineTaskList>

public class DiffInlineTaskMarshaller
extends java.lang.Object
implements Marshaller<InlineTaskList>

This DiffInlineTaskMarshaller outputs inline task lists in a diffable way:

• As little whitespace/CRs as possible, because it disturbs the diff,
• DaisyDiff doesn't diffs lists properly when they contain multiple spans, and it puts spans outside the LI and inside the UL, which doesn't produce a workable output. Thus, we don't use UL and LI.
• Use <inline-task-list-ul/> in place of UL. Keeps the css class on it so that it presents nicely when diff-cleanup.xsl transforms it back to UL.
• Use <inline-task-list-li/> in lieu of LI. No task ID on it, as the diff purpose isn't to compare task ids.
• Use <inline-task-check-marker class="inline-task [checked]">&nbsp;</inline-task-check-marker> for the tick, so that it can be compared separately

Constructor Summary

Constructors

Constructor and Description
DiffInlineTaskMarshaller(javax.xml.stream.XMLOutputFactory xmlOutputFactory)

Method Summary

Methods

Modifier and Type	Method and Description
Streamable	marshal(InlineTaskList inlineTaskList, ConversionContext conversionContext) Marshals an object to XML.
protected void	writeInlineTaskImage(javax.xml.stream.XMLStreamWriter xmlStreamWriter, InlineTaskListItem listItem)

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffInlineTaskMarshaller

public DiffInlineTaskMarshaller(javax.xml.stream.XMLOutputFactory xmlOutputFactory)

Method Detail

marshal

public Streamable marshal(InlineTaskList inlineTaskList,
                 ConversionContext conversionContext)
                   throws XhtmlException

Description copied from interface: Marshaller

Marshals an object to XML.

Specified by:

marshal in interface Marshaller<InlineTaskList>

Parameters:

inlineTaskList - object to marshal

conversionContext - the conversion context

Returns:

the XML representation of the object

Throws:

XhtmlException - if an error occurs during marshalling

writeInlineTaskImage

protected void writeInlineTaskImage(javax.xml.stream.XMLStreamWriter xmlStreamWriter,
                        InlineTaskListItem listItem)
                             throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException