Storable.java :  » Search » obsearch » net » obsearch » Java Open Source

/**
 * 
 */
package net.obsearch;

import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.nio.ByteBuffer;

import net.obsearch.exception.OBException;


/*
 * OBSearch: a distributed similarity search engine This project is to
 * similarity search what 'bit-torrent' is to downloads. Copyright (C) 2007
 * Arnoldo Jose Muller Molina This program is free software: you can
 * redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version. This program is distributed
 * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received
 * a copy of the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 */
/**
 * Interface that abstracts the general storage and loading methods used to
 * persist objects.
 * @author Arnoldo Jose Muller Molina
 * @since 0.7
 */

public interface Storable {
    /**
     * Stores this object in a byte array.
     * @param out
     *            A DataOutputStream where values can be stored
     * @since 0.0
     */
    byte[] store() throws OBException, IOException;

    /**
     * Populates the object's internal properties from the given byte stream.    
     * @param input
     *            byte array from where we will load data.
     * @throws OBException
     *             if the data cannot be loaded.
     * @since 0.0
     */
    void load(byte[] input) throws OBException, IOException;
}