src/share/classes/com/sun/javadoc/SourcePosition.java

Tue, 24 Dec 2013 09:17:37 -0800

author
ksrini
date
Tue, 24 Dec 2013 09:17:37 -0800
changeset 2227
998b10c43157
parent 554
9d9f26857129
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com

duke@1 1 /*
ohair@554 2 * Copyright (c) 2001, 2002, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.javadoc;
duke@1 27
duke@1 28 import java.io.File;
duke@1 29
duke@1 30 /**
duke@1 31 * This interface describes a source position: filename, line number,
duke@1 32 * and column number.
duke@1 33 *
duke@1 34 * @since 1.4
duke@1 35 * @author Neal M Gafter
duke@1 36 */
duke@1 37 public interface SourcePosition {
duke@1 38 /** The source file. Returns null if no file information is
duke@1 39 * available. */
duke@1 40 File file();
duke@1 41
duke@1 42 /** The line in the source file. The first line is numbered 1;
duke@1 43 * 0 means no line number information is available. */
duke@1 44 int line();
duke@1 45
duke@1 46 /** The column in the source file. The first column is
duke@1 47 * numbered 1; 0 means no column information is available.
duke@1 48 * Columns count characters in the input stream; a tab
duke@1 49 * advances the column number to the next 8-column tab stop.
duke@1 50 */
duke@1 51 int column();
duke@1 52
duke@1 53 /** Convert the source position to the form "Filename:line". */
duke@1 54 String toString();
duke@1 55 }

mercurial