com.xpn.xwiki.content.parsers
Class ParsingResultCollection

java.lang.Object
  extended by com.xpn.xwiki.content.parsers.ParsingResultCollection
Direct Known Subclasses:
ReplacementResultCollection

public class ParsingResultCollection
extends Object

Contains results data when parsing text in wiki syntax. The reason is that there can be syntax errors found while parsing and we don't want to stop the parsing when these happen. Instead we want to let the caller code be handle those errors as it sees fit. This is why we're returning both the valid parsed elements in addition to the parsing errors.


Constructor Summary
ParsingResultCollection()
           
 
Method Summary
 List getInvalidElementIds()
           
 List getValidElements()
           
 boolean hasInvalidElements()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParsingResultCollection

public ParsingResultCollection()
Method Detail

getValidElements

public List getValidElements()
Returns:
the valid parsed elements. For example Link objects.

getInvalidElementIds

public List getInvalidElementIds()
Returns:
the parsing errors returned as ids. Usually the id is the source content that was supposed to be parsed

hasInvalidElements

public boolean hasInvalidElements()
Returns:
true if there are parsing errors or false otherwise