001/*
002 * Copyright (c) 2005 Einar Pehrson <einar@pehrson.nu>.
003 *
004 * This file is part of
005 * CleanSheets - a workbook application for the Java platform.
006 *
007 * CleanSheets is free software; you can redistribute it and/or modify
008 * it under the terms of the GNU General Public License as published by
009 * the Free Software Foundation; either version 2 of the License, or
010 * (at your option) any later version.
011 *
012 * CleanSheets is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
015 * GNU General Public License for more details.
016 *
017 * You should have received a copy of the GNU General Public License
018 * along with CleanSheets; if not, write to the Free Software
019 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
020 */
021package csheets.io;
022
023import java.io.IOException;
024import java.io.InputStream;
025import java.io.OutputStream;
026
027import csheets.core.Workbook;
028
029/**
030 * An interface for classes capable of reading and writing workbooks.
031 * @author Einar Pehrson
032 */
033public interface Codec {
034
035        /**
036         * Reads a workbook from the given input stream.
037         * @param stream the input stream from which the workbook should be read
038         * @throws IOException if the workbook could not be read correctly
039         * @throws ClassNotFoundException If the class of a serialized object could not be found
040         */
041        public Workbook read(InputStream stream) throws IOException, ClassNotFoundException;
042
043        /**
044         * Writes a workbook to the given output stream.
045         * @param stream the output stream to which the workbook should be written
046         * @throws IOException if the workbook could not be written correctly
047         */
048        public void write(Workbook workbook, OutputStream stream) throws IOException;
049}