Update the documentation for recoverInline to advise against

consumption.
This commit is contained in:
Michael Peyton Jones 2015-01-19 17:47:14 +00:00
parent 9e09e6a9c0
commit 3d71fc99d6
1 changed files with 3 additions and 0 deletions

View File

@ -63,6 +63,9 @@ public interface ANTLRErrorStrategy {
* returns the {@link Token} instance which should be treated as the
* successful result of the match.
*
* <p>This method handles the consumption of any tokens - the caller should
* <b>not</b> call {@link Parser#consume} after a successful recovery.</p>
*
* <p>Note that the calling code will not report an error if this method
* returns successfully. The error strategy implementation is responsible
* for calling {@link Parser#notifyErrorListeners} as appropriate.</p>