1   /*
2    *  Copyright (c) 1998-2005, The University of Sheffield.
3    *
4    *  This file is part of GATE (see http://gate.ac.uk/), and is free
5    *  software, licenced under the GNU Library General Public License,
6    *  Version 2, June 1991 (in the distribution as file licence.html,
7    *  and also available at http://gate.ac.uk/gate/licence.html).
8    *
9    *  Valentin Tablan, June 12th 2002
10   *
11   *  $Id: TextualDocument.java,v 1.10 2005/01/11 13:51:30 ian Exp $
12   */
13  package gate;
14  
15  /**
16   * Top interface for all types of textual documents (transient or persistent).
17   * Extends the {@link Document} interface with the encoding property.
18   */
19  public interface TextualDocument extends Document {
20    /**
21     * Gets the encoding used for this document. This encoding has been used to
22     * read the content for the document and will be used for dumping this
23     * document to other textual formats such as XML.
24     * @return a String value.
25     */
26    public String getEncoding();
27  }