001// Copyright 2006 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.commons;
016
017/**
018 * A kind of tag applied to other objects to identify where they came from, in terms of a file (the resource), a line
019 * number, and a column number. This is part of "line precise exception reporting", whereby errors at runtime can be
020 * tracked backwards to the files from which they were parsed or otherwise constructed.
021 */
022public interface Location
023{
024    /**
025     * The resource from which the object tagged with a location was derived.
026     */
027    Resource getResource();
028
029    /**
030     * The line number within the resource, if known, or -1 otherwise.
031     */
032    int getLine();
033
034    /**
035     * The column number within the line if known, or -1 otherwise.
036     */
037    int getColumn();
038}