//==============================================================================
// tribble/io/TextLineI.java
//------------------------------------------------------------------------------

package tribble.io;


// System imports

import java.lang.String;


// Local imports

// (None)


/*******************************************************************************
* Generic numbered text line interface.
*
* <p>
* This interface is used to implement classes representing a single line of
* text.  Such a stream can be used to hold text lines read from a source file.
*
* <p>
* This interface is used by the {@link LineInputStreamI} interface methods.
*
* <!------------------------------------------------------------------------ -->
* @version	$Revision: 1.3 $ $Date: 2003/09/06 19:16:04 $
* @since	2001-04-22
* @author
*	David R. Tribble
*	(<a href="mailto:david@tribble.com">david@tribble.com</a>).
*	<br>
*	<a href="../Copyright.html">Copyright</a> ©2001-2003
*	by David R. Tribble, all rights reserved.
*	<br>
*	Permission is granted to freely use and distribute this source code
*	provided that the original copyright and authorship notices remain
*	intact.
*
* @see	LineInputStreamI
*/

public interface TextLineI
{
// Identification

    /** Revision information. */
    static final String		REV =
        "@(#)tribble/io/TextLineI.java $Revision: 1.3 $ $Date: 2003/09/06 19:16:04 $\n";


// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Public methods

    /***************************************************************************
    * Retrieves the textual contents of this text line.
    *
    * @return
    * The contents of this text line.
    *
    * @since	1.1, 2001-04-22
    */

    public String getText();


    /***************************************************************************
    * Retrieves the source line number of this text line.
    *
    * @return
    * The source line number of this text line.
    *
    * @since	1.1, 2001-04-22
    */

    public int getLineNo();


    /***************************************************************************
    * Retrieves the source filename of this token.
    *
    * @return
    * The source filename for this token.
    *
    * @since	1.1, 2001-04-22
    */

    public String getFileName();
}

// End TextLineI.java