This Walker implementation walks a list of Content in a Formatted form of some sort.

The JDOM content can be loosely categorised in to 'Text-like' content (consisting of Text, CDATA, and EntityRef), and everything else. This distinction is significant for for this class and its sub-classes.

There will be text manipulation, and some (but not necessarily all) Text-like content will be returned as text() instead of next().

The trick in this class is that it deals with the regular content, and delegates the Text-like content to the sub-classes.

Subclasses are tasked with analysing chunks of Text-like content in the analyzeMultiText(MultiText, int, int) method. The subclasses are responsible for adding the relevant text content to the suppliedMultiText instance in such a way as to result in the correct format.

The Subclass needs to concern itself with only the text portion because this abstract class will ensure the Text-like content is appropriately indented.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	AbstractFormattedWalker.MultiText Collect together the items that constitute formatted Text-like content.
protected static enum	AbstractFormattedWalker.Trim Indicate how text content should be added

Field Summary

Modifier and Type	Field and Description
private final boolean	alltext
private final boolean	allwhite
private static final CDATA	CDATATOKEN
private final Iterator<? extends Content>	content
private static final Iterator<Content>	EMPTYIT
private final String	endofline
private final EscapeStrategy	escape
private final FormatStack	fstack
private boolean	hasnext
private final AbstractFormattedWalker.MultiText	holdingmt
private final StringBuilder	mtbuffer
private Content[]	mtdata
private boolean	mtgottext
private int	mtpos
private boolean	mtpostpad
private int	mtsize
private Content[]	mtsource
private int	mtsourcesize
private String[]	mttext
private Boolean	mtwasescape
private AbstractFormattedWalker.MultiText	multitext
private final String	newlineindent
private Content	pending
private AbstractFormattedWalker.MultiText	pendingmt

Constructor Summary

Access	Constructor and Description
public	AbstractFormattedWalker(final List<? extends Content> the content to walk. xx, final FormatStack the current FormatStack fstack, final boolean Whether Text values should be escaped. doescape) Create a Walker that preserves all content in its raw state.

Method Summary

Modifier and Type	Method and Description
protected abstract void	analyzeMultiText(AbstractFormattedWalker.MultiText the MultiText to append to. mtext, int The first Text-like content to add to the MultiText offset, int The number of Text-like content items to add. len) Add the content at the specified indices to the provided MultiText.
private final AbstractFormattedWalker.MultiText	Returns: The updated MultiText containing the correct sequence of Text-like content buildMultiText(final boolean first) This method was changed in 2.0.5 It now is only called when building the content of the variable pendingmt This is important, because only pendingmt can be referenced when analyzing the MultiText content.
protected final Content	Returns: the content at the index. get(final int the index to get the content at. index) Get the content at a position in the input content.
public final boolean	hasNext() Implements org.jdom2.output.support.Walker.hasNext. Behaves similarly to to a regular Iterator
public final boolean	isAllText() Implements org.jdom2.output.support.Walker.isAllText. If all the content in this walker is empty, or if whatever content is available is Text-like.
public final boolean	isAllWhitespace() Implements org.jdom2.output.support.Walker.isAllWhitespace. If all the content is Text-like (`isAllText()` returns true), and additionally that any content is either Text or CDATA, and that the values of these Text/CDATA members are all XML Whitespace.
public final boolean	isCDATA() Implements org.jdom2.output.support.Walker.isCDATA. If the previous next() method returned null, then this will indicate whether the current text() value is CDATA or regular Text.
private final boolean	isTextLike(final Content c)
public final Content	next() Implements org.jdom2.output.support.Walker.next. Similar to an Iterator, but null return values need special treatment.
private void	resetMultiText()
public final String	text() Implements org.jdom2.output.support.Walker.text. If the previous call to next() returned null, then this will return the required text to be processed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

alltext	back to summary
private final boolean alltext

allwhite	back to summary
private final boolean allwhite

CDATATOKEN	back to summary
private static final CDATA CDATATOKEN

content	back to summary
private final Iterator<? extends Content> content

EMPTYIT	back to summary
private static final Iterator<Content> EMPTYIT

endofline	back to summary
private final String endofline

escape	back to summary
private final EscapeStrategy escape

fstack	back to summary
private final FormatStack fstack

hasnext	back to summary
private boolean hasnext

holdingmt	back to summary
private final AbstractFormattedWalker.MultiText holdingmt

mtbuffer	back to summary
private final StringBuilder mtbuffer

mtdata	back to summary
private Content[] mtdata

mtgottext	back to summary
private boolean mtgottext

mtpos	back to summary
private int mtpos

mtpostpad	back to summary
private boolean mtpostpad

mtsize	back to summary
private int mtsize

mtsource	back to summary
private Content[] mtsource

mtsourcesize	back to summary
private int mtsourcesize

mttext	back to summary
private String[] mttext

mtwasescape	back to summary
private Boolean mtwasescape

multitext	back to summary
private AbstractFormattedWalker.MultiText multitext

newlineindent	back to summary
private final String newlineindent

pending	back to summary
private Content pending

pendingmt	back to summary
private AbstractFormattedWalker.MultiText pendingmt

Constructor Detail

AbstractFormattedWalker	back to summary
public AbstractFormattedWalker(final List<? extends Content> xx, final FormatStack fstack, final boolean doescape) Create a Walker that preserves all content in its raw state. Parameters xx:List<? extends Content> the content to walk. fstack:FormatStack the current FormatStack doescape:boolean Whether Text values should be escaped.

AbstractFormattedWalker

back to summary

public AbstractFormattedWalker(final List<? extends Content> xx, final FormatStack fstack, final boolean doescape)

Create a Walker that preserves all content in its raw state.

Parameters

xx:List<? extends Content>: the content to walk.
fstack:FormatStack: the current FormatStack
doescape:boolean: Whether Text values should be escaped.

Method Detail

analyzeMultiText	back to summary
protected abstract void analyzeMultiText(AbstractFormattedWalker.MultiText mtext, int offset, int len) Add the content at the specified indices to the provided MultiText. Parameters mtext:AbstractFormattedWalker.MultiText the MultiText to append to. offset:int The first Text-like content to add to the MultiText len:int The number of Text-like content items to add.

analyzeMultiText

back to summary

protected abstract void analyzeMultiText(AbstractFormattedWalker.MultiText mtext, int offset, int len)

Add the content at the specified indices to the provided MultiText.

Parameters

mtext:AbstractFormattedWalker.MultiText: the MultiText to append to.
offset:int: The first Text-like content to add to the MultiText
len:int: The number of Text-like content items to add.

buildMultiText	back to summary
private final AbstractFormattedWalker.MultiText buildMultiText(final boolean first) This method was changed in 2.0.5 It now is only called when building the content of the variable pendingmt This is important, because only pendingmt can be referenced when analyzing the MultiText content. Returns:AbstractFormattedWalker.MultiText The updated MultiText containing the correct sequence of Text-like content

buildMultiText

back to summary

private final AbstractFormattedWalker.MultiText buildMultiText(final boolean first)

This method was changed in 2.0.5 It now is only called when building the content of the variable pendingmt This is important, because only pendingmt can be referenced when analyzing the MultiText content.

Returns:AbstractFormattedWalker.MultiText: The updated MultiText containing the correct sequence of Text-like content

get back to summary

get	back to summary
protected final Content get(final int index) Get the content at a position in the input content. Useful for subclasses in their `analyzeMultiText(MultiText, int, int)` calls. Parameters index:int the index to get the content at. Returns:Content the content at the index.

protected final Content get(final int index)

Get the content at a position in the input content. Useful for subclasses in their analyzeMultiText(MultiText, int, int) calls.

Parameters

index:int: the index to get the content at.

Returns:Content

the content at the index.

hasNext	back to summary
public final boolean hasNext() Implements org.jdom2.output.support.Walker.hasNext. Doc from org.jdom2.output.support.Walker.hasNext. Behaves similarly to to a regular Iterator Returns:boolean true if there is more content to be processed Annotations @Override

hasNext

back to summary

public final boolean hasNext()

Implements org.jdom2.output.support.Walker.hasNext.

Doc from org.jdom2.output.support.Walker.hasNext.

Behaves similarly to to a regular Iterator

Returns:boolean

true if there is more content to be processed

Annotations

@Override

isAllText back to summary

isAllText	back to summary
public final boolean isAllText() Implements org.jdom2.output.support.Walker.isAllText. Doc from org.jdom2.output.support.Walker.isAllText. If all the content in this walker is empty, or if whatever content is available is Text-like. Text-like content is considered to be `Text`, `CDATA`, `EntityRef`, or any (potentially mixed) sequence of these types, but no other types. Returns:boolean true if there is no content, or all content is Text Annotations @Override

public final boolean isAllText()

Implements org.jdom2.output.support.Walker.isAllText.

Doc from org.jdom2.output.support.Walker.isAllText.

If all the content in this walker is empty, or if whatever content is available is Text-like.

Text-like content is considered to be Text, CDATA, EntityRef, or any (potentially mixed) sequence of these types, but no other types.

Returns:boolean

true if there is no content, or all content is Text

Annotations

@Override

isAllWhitespace back to summary

isAllWhitespace	back to summary
public final boolean isAllWhitespace() Implements org.jdom2.output.support.Walker.isAllWhitespace. Doc from org.jdom2.output.support.Walker.isAllWhitespace. If all the content is Text-like (`isAllText()` returns true), and additionally that any content is either Text or CDATA, and that the values of these Text/CDATA members are all XML Whitespace. Returns:boolean true Annotations @Override

public final boolean isAllWhitespace()

Implements org.jdom2.output.support.Walker.isAllWhitespace.

Doc from org.jdom2.output.support.Walker.isAllWhitespace.

If all the content is Text-like (isAllText() returns true), and additionally that any content is either Text or CDATA, and that the values of these Text/CDATA members are all XML Whitespace.

Returns:boolean

true

Annotations

@Override

isCDATA	back to summary
public final boolean isCDATA() Implements org.jdom2.output.support.Walker.isCDATA. Doc from org.jdom2.output.support.Walker.isCDATA. If the previous next() method returned null, then this will indicate whether the current text() value is CDATA or regular Text. Returns:boolean true if the current text() is valid, and is CDATA. Annotations @Override

isCDATA

back to summary

public final boolean isCDATA()

Implements org.jdom2.output.support.Walker.isCDATA.

Doc from org.jdom2.output.support.Walker.isCDATA.

If the previous next() method returned null, then this will indicate whether the current text() value is CDATA or regular Text.

Returns:boolean

true if the current text() is valid, and is CDATA.

Annotations

@Override

isTextLike	back to summary
private final boolean isTextLike(final Content c)

next	back to summary
public final Content next() Implements org.jdom2.output.support.Walker.next. Doc from org.jdom2.output.support.Walker.next. Similar to an Iterator, but null return values need special treatment. Returns:Content the next content to be processed, perhaps null if the next content is re-formatted text of some sort (Text / CDATA). Annotations @Override

back to summary

public final Content next()

Implements org.jdom2.output.support.Walker.next.

Doc from org.jdom2.output.support.Walker.next.

Similar to an Iterator, but null return values need special treatment.

Returns:Content

the next content to be processed, perhaps null if the next content is re-formatted text of some sort (Text / CDATA).

Annotations

@Override

resetMultiText	back to summary
private void resetMultiText()

text	back to summary
public final String text() Implements org.jdom2.output.support.Walker.text. Doc from org.jdom2.output.support.Walker.text. If the previous call to next() returned null, then this will return the required text to be processed. Check to see whether this text is CDATA by calling the isCDATA() method. Returns:String The current text value (null if the previous invocation of next() returned a non-null value). Annotations @Override

text

back to summary

public final String text()

Implements org.jdom2.output.support.Walker.text.

Doc from org.jdom2.output.support.Walker.text.

If the previous call to next() returned null, then this will return the required text to be processed. Check to see whether this text is CDATA by calling the isCDATA() method.

Returns:String

The current text value (null if the previous invocation of next() returned a non-null value).

Annotations

@Override

org.jdom2.output.support back to summary

protected final Class AbstractFormattedWalker.MultiText

Class Inheritance

extends Object

java.lang.Object
org.jdom2.output.support.AbstractFormattedWalker.MultiText

Collect together the items that constitute formatted Text-like content.

Author: Rolf Lear

Constructor Summary

Access	Constructor and Description
private	MultiText() This is private so only this abstract class can create instances.

Method Summary

Modifier and Type	Method and Description
public void	appendCDATA(final AbstractFormattedWalker.Trim How to prepare the CDATA content trim, final String The actual CDATA content. text) Append some text to the text-like sequence that will be treated as CDATA.
public void	appendRaw(final Content the content to add. c) Add some JDOM Content (typically an EntityRef) that will be treated as part of the Text-like sequence.
public void	appendText(final AbstractFormattedWalker.Trim How to prepare the Text content trim, final String The actual Text content. text) Append some text to the text-like sequence that will be treated as plain XML text (PCDATA).
private void	closeText() Handle the case where we have been accumulating true text content, and the next item is not more text.
public void	done() Indicate that there is no further content to be added to the text-like sequence.
private void	ensurespace() Ensure we have space for at least one more text-like item.
private String	escapeCDATA(final String text)
private String	escapeText(final String text)
private void	forceAppend(final String text) Simple method that ensures the text is processed, regardless of content, and is never escaped.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

MultiText	back to summary
private MultiText() This is private so only this abstract class can create instances.

Method Detail

appendCDATA	back to summary
public void appendCDATA(final AbstractFormattedWalker.Trim trim, final String text) Append some text to the text-like sequence that will be treated as CDATA. Parameters trim:AbstractFormattedWalker.Trim How to prepare the CDATA content text:String The actual CDATA content.

appendCDATA

back to summary

public void appendCDATA(final AbstractFormattedWalker.Trim trim, final String text)

Append some text to the text-like sequence that will be treated as CDATA.

Parameters

trim:AbstractFormattedWalker.Trim: How to prepare the CDATA content
text:String: The actual CDATA content.

appendRaw	back to summary
public void appendRaw(final Content c) Add some JDOM Content (typically an EntityRef) that will be treated as part of the Text-like sequence. Parameters c:Content the content to add.

appendRaw

back to summary

public void appendRaw(final Content c)

Add some JDOM Content (typically an EntityRef) that will be treated as part of the Text-like sequence.

Parameters

c:Content: the content to add.

appendText	back to summary
public void appendText(final AbstractFormattedWalker.Trim trim, final String text) Append some text to the text-like sequence that will be treated as plain XML text (PCDATA). If the last content added to this text-like sequence then this new text will be appended directly to the previous text. Parameters trim:AbstractFormattedWalker.Trim How to prepare the Text content text:String The actual Text content.

appendText

back to summary

public void appendText(final AbstractFormattedWalker.Trim trim, final String text)

Append some text to the text-like sequence that will be treated as plain XML text (PCDATA). If the last content added to this text-like sequence then this new text will be appended directly to the previous text.

Parameters

trim:AbstractFormattedWalker.Trim: How to prepare the Text content
text:String: The actual Text content.

closeText	back to summary
private void closeText() Handle the case where we have been accumulating true text content, and the next item is not more text.

done	back to summary
public void done() Indicate that there is no further content to be added to the text-like sequence.

ensurespace	back to summary
private void ensurespace() Ensure we have space for at least one more text-like item.

escapeCDATA	back to summary
private String escapeCDATA(final String text)

escapeText	back to summary
private String escapeText(final String text)

forceAppend	back to summary
private void forceAppend(final String text) Simple method that ensures the text is processed, regardless of content, and is never escaped.

org.jdom2.output.support back to summary

protected final Enum AbstractFormattedWalker.Trim

Class Inheritance

extends Enum<AbstractFormattedWalker.Trim>

java.lang.Object
java.lang.Enum
org.jdom2.output.support.AbstractFormattedWalker.Trim

Indicate how text content should be added

Author: Rolf Lear

Field Summary

Modifier and Type	Field and Description
public static final AbstractFormattedWalker.Trim	BOTH Both Trim
public static final AbstractFormattedWalker.Trim	COMPACT Trim Both and replace all internal whitespace with a single space
public static final AbstractFormattedWalker.Trim	LEFT Left Trim
public static final AbstractFormattedWalker.Trim	NONE No Trimming at all
public static final AbstractFormattedWalker.Trim	RIGHT Right Trim

Constructor Summary

Access	Constructor and Description
private	Trim()

Method Summary

Modifier and Type	Method and Description
public static AbstractFormattedWalker.Trim	valueOf(String name)
public static AbstractFormattedWalker.Trim[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BOTH	back to summary
public static final AbstractFormattedWalker.Trim BOTH Both Trim

COMPACT	back to summary
public static final AbstractFormattedWalker.Trim COMPACT Trim Both and replace all internal whitespace with a single space

LEFT	back to summary
public static final AbstractFormattedWalker.Trim LEFT Left Trim

NONE	back to summary
public static final AbstractFormattedWalker.Trim NONE No Trimming at all

RIGHT	back to summary
public static final AbstractFormattedWalker.Trim RIGHT Right Trim

Constructor Detail

Trim	back to summary
private Trim()

Method Detail

valueOf	back to summary
public static AbstractFormattedWalker.Trim valueOf(String name)

values	back to summary
public static AbstractFormattedWalker.Trim[] values()

public abstract Class AbstractFormattedWalker

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Class AbstractFormattedWalker.MultiText

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected final Enum AbstractFormattedWalker.Trim

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail