View Javadoc

1   /* ReplayCharSequence
2    *
3    * Created on Mar 5, 2004
4    *
5    * Copyright (C) 2004 Internet Archive.
6    *
7    * This file is part of the Heritrix web crawler (crawler.archive.org).
8    *
9    * Heritrix is free software; you can redistribute it and/or modify
10   * it under the terms of the GNU Lesser Public License as published by
11   * the Free Software Foundation; either version 2.1 of the License, or
12   * any later version.
13   *
14   * Heritrix is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU Lesser Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser Public License
20   * along with Heritrix; if not, write to the Free Software
21   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22   */
23  package org.archive.io;
24  
25  import java.io.IOException;
26  
27  
28  /***
29   * CharSequence interface with addition of a {@link #close()} method.
30   *
31   * Users of implementations of this interface must call {@link #close()} so
32   * implementations get a chance at cleaning up after themselves.
33   *
34   * @author stack
35   * @version $Revision: 3288 $, $Date: 2005-03-31 17:43:23 +0000 (Thu, 31 Mar 2005) $
36   */
37  public interface ReplayCharSequence extends CharSequence {
38  
39      /***
40       * Call this method when done so implementation has chance to clean up
41       * resources.
42       *
43       * @throws IOException Problem cleaning up file system resources.
44       */
45      public void close() throws IOException;
46  }