KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > util > location > Location


1 /*
2  * Copyright 2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.util.location;
17
18
19 /**
20  * A location in a resource. The location is composed of the URI of the resource, and
21  * the line and column numbers within that resource (when available), along with a description.
22  * <p>
23  * Locations are mostly provided by {@link Locatable}s objects.
24  *
25  * @since 2.1.8
26  * @version $Id: Location.java 232525 2005-08-13 21:20:59Z sylvain $
27  */
28 public interface Location {
29     
30     /**
31      * Constant for unknown locations.
32      */
33     public static final Location UNKNOWN = LocationImpl.UNKNOWN;
34     
35     /**
36      * Get the description of this location
37      *
38      * @return the description (can be <code>null</code>)
39      */
40     public String JavaDoc getDescription();
41     
42     /**
43      * Get the URI of this location
44      *
45      * @return the URI (<code>null</code> if unknown).
46      */
47     public String JavaDoc getURI();
48     /**
49      * Get the line number of this location
50      *
51      * @return the line number (<code>-1</code> if unknown)
52      */
53     public int getLineNumber();
54     
55     /**
56      * Get the column number of this location
57      *
58      * @return the column number (<code>-1</code> if unknown)
59      */
60     public int getColumnNumber();
61
62 }
63
Popular Tags