Addressbook/src/org/mxchange/addressbook/database/frontend/DatabaseFrontend.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.frontend;
  18
  19 import org.mxchange.addressbook.FrameworkInterface;
  20 import org.mxchange.addressbook.database.storage.Storeable;
  21 import org.mxchange.addressbook.exceptions.BadTokenException;
  22
  23 /**
  24  * A generic interface for database frontends
  25  *
  26  * @author Roland Haeder
  27  */
  28 public interface DatabaseFrontend extends FrameworkInterface {
  29         /**
  30          * Parses given line from database backend into a Storeable instance. Please
  31          * note that not all backends need this.
  32          *
  33          * @param line Line from database backend
  34          * @return A Storeable instance
  35          * @throws org.mxchange.addressbook.exceptions.BadTokenException If a token was badly formatted
  36          */
  37         public Storeable parseLineToStoreable (final String line) throws BadTokenException;
  38 }