src/core/net/sf/basedb/util/parser/WrappedConfigureByExample.java

Code
Comments
Other
Rev Date Author Line
4105 28 Jan 08 nicklas 1 /**
4105 28 Jan 08 nicklas 2   $Id$
4105 28 Jan 08 nicklas 3
4105 28 Jan 08 nicklas 4   Copyright (C) 2006 Nicklas Nordborg
4105 28 Jan 08 nicklas 5
4105 28 Jan 08 nicklas 6   This file is part of BASE - BioArray Software Environment.
4105 28 Jan 08 nicklas 7   Available at http://base.thep.lu.se/
4105 28 Jan 08 nicklas 8
4105 28 Jan 08 nicklas 9   BASE is free software; you can redistribute it and/or
4105 28 Jan 08 nicklas 10   modify it under the terms of the GNU General Public License
4479 05 Sep 08 jari 11   as published by the Free Software Foundation; either version 3
4105 28 Jan 08 nicklas 12   of the License, or (at your option) any later version.
4105 28 Jan 08 nicklas 13
4105 28 Jan 08 nicklas 14   BASE is distributed in the hope that it will be useful,
4105 28 Jan 08 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
4105 28 Jan 08 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4105 28 Jan 08 nicklas 17   GNU General Public License for more details.
4105 28 Jan 08 nicklas 18
4105 28 Jan 08 nicklas 19   You should have received a copy of the GNU General Public License
4515 11 Sep 08 jari 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
4105 28 Jan 08 nicklas 21 */
4105 28 Jan 08 nicklas 22 package net.sf.basedb.util.parser;
4105 28 Jan 08 nicklas 23
4105 28 Jan 08 nicklas 24 import java.io.IOException;
4105 28 Jan 08 nicklas 25 import java.io.InputStream;
4105 28 Jan 08 nicklas 26
4105 28 Jan 08 nicklas 27 import net.sf.basedb.core.plugin.Plugin;
4105 28 Jan 08 nicklas 28
4105 28 Jan 08 nicklas 29 /**
4105 28 Jan 08 nicklas 30    This is an extension to the {@link ConfigureByExample} interface
4105 28 Jan 08 nicklas 31    that allows a plug-in to wrap an input stream with another stream.
4105 28 Jan 08 nicklas 32    This is useful if the file data is compressed, for example, with gzip.
4105 28 Jan 08 nicklas 33
4105 28 Jan 08 nicklas 34   @author nicklas
4105 28 Jan 08 nicklas 35   @version 2.6
4105 28 Jan 08 nicklas 36   @base.modified $Date$
4105 28 Jan 08 nicklas 37 */
4105 28 Jan 08 nicklas 38 public interface WrappedConfigureByExample
4105 28 Jan 08 nicklas 39   extends Plugin
4105 28 Jan 08 nicklas 40 {
4105 28 Jan 08 nicklas 41
4105 28 Jan 08 nicklas 42   /**
4105 28 Jan 08 nicklas 43     Wrap an input stream within another stream, for example, a gzip input stream.
4105 28 Jan 08 nicklas 44     @param in The input stream to wrap
4105 28 Jan 08 nicklas 45     @return The same or a different input stream
4105 28 Jan 08 nicklas 46     @throws IOException If there is an error
4105 28 Jan 08 nicklas 47   */
4105 28 Jan 08 nicklas 48   public InputStream wrapInputStream(InputStream in)
4105 28 Jan 08 nicklas 49     throws IOException;
4105 28 Jan 08 nicklas 50   
4105 28 Jan 08 nicklas 51 }

Generated on Sat Oct  7 02:39:15 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)