TextualDocument.java
01 /*
02  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
03  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
04  *
05  *  This file is part of GATE (see http://gate.ac.uk/), and is free
06  *  software, licenced under the GNU Library General Public License,
07  *  Version 2, June 1991 (in the distribution as file licence.html,
08  *  and also available at http://gate.ac.uk/gate/licence.html).
09  *
10  *  Valentin Tablan, June 12th 2002
11  *
12  *  $Id: TextualDocument.java 15333 2012-02-07 13:18:33Z ian_roberts $
13  */
14 package gate;
15 
16 /**
17  * Top interface for all types of textual documents (transient or persistent).
18  * Extends the {@link Document} interface with the encoding property.
19  */
20 public interface TextualDocument extends Document {
21   /**
22    * Gets the encoding used for this document. This encoding has been used to
23    * read the content for the document and will be used for dumping this
24    * document to other textual formats such as XML.
25    @return a String value.
26    */
27   public String getEncoding();
28 }