Addressbook/src/org/mxchange/addressbook/database/backend/DatabaseBackend.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.addressbook.database.backend;
  18
  19 import java.io.IOException;
  20 import org.mxchange.addressbook.FrameworkInterface;
  21 import org.mxchange.addressbook.database.storage.Storeable;
  22
  23 /**
  24  * A generic interface for database frontends
  25  *
  26  * @author Roland Haeder
  27  */
  28 public interface DatabaseBackend extends FrameworkInterface {
  29
  30         /**
  31          * Shuts down this backend
  32          */
  33         public void doShutdown ();
  34
  35         /**
  36          * Rewinds backend
  37          */
  38         public void rewind ();
  39
  40         /**
  41          * Get length of underlaying file
  42          *
  43          * @return Length of underlaying file
  44          */
  45         public long length ();
  46
  47         /**
  48          * Stores an object in the database.
  49          *
  50          * @param object Object to store in database
  51          * @throws java.io.IOException From inner class
  52          */
  53         public void store (final Storeable object) throws IOException;
  54 }