1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/share/classes/com/sun/javadoc/SourcePosition.java Sat Dec 01 00:00:00 2007 +0000 1.3 @@ -0,0 +1,55 @@ 1.4 +/* 1.5 + * Copyright 2001-2002 Sun Microsystems, Inc. All Rights Reserved. 1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.7 + * 1.8 + * This code is free software; you can redistribute it and/or modify it 1.9 + * under the terms of the GNU General Public License version 2 only, as 1.10 + * published by the Free Software Foundation. Sun designates this 1.11 + * particular file as subject to the "Classpath" exception as provided 1.12 + * by Sun in the LICENSE file that accompanied this code. 1.13 + * 1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT 1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1.17 + * version 2 for more details (a copy is included in the LICENSE file that 1.18 + * accompanied this code). 1.19 + * 1.20 + * You should have received a copy of the GNU General Public License version 1.21 + * 2 along with this work; if not, write to the Free Software Foundation, 1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1.23 + * 1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or 1.26 + * have any questions. 1.27 + */ 1.28 + 1.29 +package com.sun.javadoc; 1.30 + 1.31 +import java.io.File; 1.32 + 1.33 +/** 1.34 + * This interface describes a source position: filename, line number, 1.35 + * and column number. 1.36 + * 1.37 + * @since 1.4 1.38 + * @author Neal M Gafter 1.39 + */ 1.40 +public interface SourcePosition { 1.41 + /** The source file. Returns null if no file information is 1.42 + * available. */ 1.43 + File file(); 1.44 + 1.45 + /** The line in the source file. The first line is numbered 1; 1.46 + * 0 means no line number information is available. */ 1.47 + int line(); 1.48 + 1.49 + /** The column in the source file. The first column is 1.50 + * numbered 1; 0 means no column information is available. 1.51 + * Columns count characters in the input stream; a tab 1.52 + * advances the column number to the next 8-column tab stop. 1.53 + */ 1.54 + int column(); 1.55 + 1.56 + /** Convert the source position to the form "Filename:line". */ 1.57 + String toString(); 1.58 +}