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

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

mercurial