01: package javanet.staxutils;
02:
03: import org.xml.sax.Locator;
04:
05: /**
06: * A dummy locator that returns -1 and null from all methods to
07: * indicate that location info is not available.
08: *
09: * @author Ryan.Shoemaker@Sun.COM
10: */
11: public class DummyLocator implements Locator {
12:
13: /**
14: * Return the column number where the current document event ends.
15: * <p/>
16: * <p><strong>Warning:</strong> The return value from the method
17: * is intended only as an approximation for the sake of error
18: * reporting; it is not intended to provide sufficient information
19: * to edit the character content of the original XML document.</p>
20: * <p/>
21: * <p>The return value is an approximation of the column number
22: * in the document entity or external parsed entity where the
23: * markup triggering the event appears.</p>
24: * <p/>
25: * <p>If possible, the SAX driver should provide the line position
26: * of the first character after the text associated with the document
27: * event.</p>
28: * <p/>
29: * <p>If possible, the SAX driver should provide the line position
30: * of the first character after the text associated with the document
31: * event. The first column in each line is column 1.</p>
32: *
33: * @return The column number, or -1 if none is available.
34: * @see #getLineNumber
35: */
36: public int getColumnNumber() {
37: return -1;
38: }
39:
40: /**
41: * Return the line number where the current document event ends.
42: * <p/>
43: * <p><strong>Warning:</strong> The return value from the method
44: * is intended only as an approximation for the sake of error
45: * reporting; it is not intended to provide sufficient information
46: * to edit the character content of the original XML document.</p>
47: * <p/>
48: * <p>The return value is an approximation of the line number
49: * in the document entity or external parsed entity where the
50: * markup triggering the event appears.</p>
51: * <p/>
52: * <p>If possible, the SAX driver should provide the line position
53: * of the first character after the text associated with the document
54: * event. The first line in the document is line 1.</p>
55: *
56: * @return The line number, or -1 if none is available.
57: * @see #getColumnNumber
58: */
59: public int getLineNumber() {
60: return -1;
61: }
62:
63: /**
64: * Return the public identifier for the current document event.
65: * <p/>
66: * <p>The return value is the public identifier of the document
67: * entity or of the external parsed entity in which the markup
68: * triggering the event appears.</p>
69: *
70: * @return A string containing the public identifier, or
71: * null if none is available.
72: * @see #getSystemId
73: */
74: public String getPublicId() {
75: return null;
76: }
77:
78: /**
79: * Return the system identifier for the current document event.
80: * <p/>
81: * <p>The return value is the system identifier of the document
82: * entity or of the external parsed entity in which the markup
83: * triggering the event appears.</p>
84: * <p/>
85: * <p>If the system identifier is a URL, the parser must resolve it
86: * fully before passing it to the application.</p>
87: *
88: * @return A string containing the system identifier, or null
89: * if none is available.
90: * @see #getPublicId
91: */
92: public String getSystemId() {
93: return null;
94: }
95: }
|