1 ////////////////////////////////////////////////////////////////////////////////
2 // MillScript: an Open Spice interpreter and batch website creation tool
3 // Copyright (C) 2005 Kevin Rogers
4 //
5 // This file is part of MillScript.
6 //
7 // MillScript is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU General Public License as published by the Free
9 // Software Foundation; either version 2 of the License, or (at your option)
10 // any later version.
11 //
12 // MillScript is distributed in the hope that it will be useful, but WITHOUT
13 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 // more details.
16 //
17 // You should have received a copy of the GNU General Public License along with
18 // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
19 // Place, Suite 330, Boston, MA 02111-1307 USA
20 ////////////////////////////////////////////////////////////////////////////////
21 package org.millscript.commons.alert;
22
23 /**
24 * This interface describes methods for providing the origin information for an
25 * Alert.
26 */
27 public interface AlertOrigin {
28
29 /**
30 * Returns the line number within the origin that the alert should be
31 * reported with.
32 *
33 * @return the line number for the alert
34 */
35 public int getLineNumber();
36
37 /**
38 * Returns the origin for the alert.
39 *
40 * @return the origin for the alert
41 */
42 public String getOrigin();
43
44 /**
45 * Sets the context for the decorating an alert. This method is a
46 * convenience to save calling the line number and origin methods
47 * separately.
48 *
49 * @param s the origin to decorate an alert with
50 * @param n the line number to decorate an alert with
51 */
52 public void setContext( final String s, final int n );
53
54 /**
55 * Sets the line number to decorate an alert with.
56 *
57 * @param n the line number to decorate an alert with
58 */
59 public void setLineNumber( final int n );
60
61 /**
62 * Sets the origin message to decorate an alet with.
63 *
64 * @param o the origin message to decorate an alert with
65 */
66 public void setOrigin( final String o );
67
68 }