KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jibx > runtime > ITrackSource


1 /*
2 Copyright (c) 2004, Dennis M. Sosnoski.
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without modification,
6 are permitted provided that the following conditions are met:
7
8  * Redistributions of source code must retain the above copyright notice, this
9    list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice,
11    this list of conditions and the following disclaimer in the documentation
12    and/or other materials provided with the distribution.
13  * Neither the name of JiBX nor the names of its contributors may be used
14    to endorse or promote products derived from this software without specific
15    prior written permission.
16
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package org.jibx.runtime;
30
31 /**
32  * Unmarshalling source tracking interface. This interface is added to bound
33  * classes when requested by the binding definition. It allows the user to
34  * retrieve information about the location in the input document corresponding
35  * to an unmarshalled object, if the parser used for unmarshalling supports
36  * reporting this information.
37  *
38  * @author Dennis M. Sosnoski
39  * @version 1.0
40  */
41
42 public interface ITrackSource
43 {
44     /**
45      * Get source document name.
46      *
47      * @return name given for source document, or <code>null</code> if none
48      */
49      
50     public String JavaDoc jibx_getDocumentName();
51     
52     /**
53      * Get source document line number.
54      *
55      * @return line number in source document, or <code>-1</code> if unknown
56      */
57      
58     public int jibx_getLineNumber();
59     
60     /**
61      * Get source document column number.
62      *
63      * @return column number in source document, or <code>-1</code> if unknown
64      */
65      
66     public int jibx_getColumnNumber();
67 }
68
Popular Tags