1 /***************************************************************************** 2 * Copyright (C) Zephyr Business Solutions Corp. All rights reserved. * 3 * ------------------------------------------------------------------------- * 4 * The software in this package is published under the terms of the BSD * 5 * style license a copy of which has been included with this distribution in * 6 * the LICENSE.txt file. * 7 *****************************************************************************/ 8 /* 9 * Created on Nov 18, 2004 10 * 11 * Author Ben Yu 12 */ 13 package jfun.parsec; 14 15 /** 16 * Describes Parse error. 17 * @author Ben Yu 18 * 19 * Nov 18, 2004 20 */ 21 public interface ParseError extends java.io.Serializable{ 22 23 /** 24 * Gets the index number in the original source. 25 * @return the index number. 26 */ 27 int getIndex(); 28 /** 29 * Get the "... encountered" error. 30 * @return the actually encountered token when error happens. 31 */ 32 String getEncountered(); 33 /** 34 * Get the "expecting ..." errors. 35 * @return all the expectings. 36 */ 37 String[] getExpecting(); 38 /** 39 * Get the "unexpected ..." error. 40 * @return all the unexpected. 41 */ 42 String[] getUnexpected(); 43 /** 44 * Get the user error messages. 45 * @return all the user-provided message. 46 */ 47 String[] getMessages(); 48 } 49