001    /*
002     * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.mirror.util;
027    
028    
029    import java.io.File;
030    
031    
032    /**
033     * Represents a position in a source file.
034     *
035     * @author Joseph D. Darcy
036     * @author Scott Seligman
037     * @since 1.5
038     */
039    
040    public interface SourcePosition {
041    
042        /**
043         * Returns the source file containing this position.
044         *
045         * @return the source file containing this position; never null
046         */
047        File file();
048    
049        /**
050         * Returns the line number of this position.  Lines are numbered
051         * starting with 1.
052         *
053         * @return the line number of this position, or 0 if the line
054         * number is unknown or not applicable
055         */
056        int line();
057    
058        /**
059         * Returns the column number of this position.  Columns are numbered
060         * starting with 1.
061         *
062         * @return the column number of this position, or 0 if the column
063         * number is unknown or not applicable
064         */
065        int column();
066    }