source: trunk/doc/src/javadoc/overview.html @ 3415

Last change on this file since 3415 was 3415, checked in by Nicklas Nordborg, 14 years ago

References #552, #553, #554: More information about backwards compatibility and Public vs. Internal
API.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 2.6 KB
Line 
1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
3<!--
4    $Id: overview.html 3415 2007-05-31 07:33:52Z nicklas $
5
6    Copyright (C) 2005-2007 Jari Häkkinen, Nicklas Nordborg, Gregory Vincic
7
8    This file is part of BASE - BioArray Software Environment.
9    Available at http://base.thep.lu.se/
10
11    BASE is free software; you can redistribute it and/or modify it
12    under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 2 of the License, or
14    (at your option) any later version.
15
16    BASE is distributed in the hope that it will be useful, but
17    WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19    General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with this program; if not, write to the Free Software
23    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24    02111-1307, USA.
25-->
26
27<body>
28  <h2>The BASE API</h2>
29
30  <p>
31  The <b>Public API</b> is intended to be used by client application
32  or plug-in developers. We guarantee a certain degree of stability
33  among the classes and methods in the public API. See documentation
34  on the <a href="http://base.thep.lu.se/chrome/site/doc/docbook/html/developerdoc/api/api_overview.html"
35    >BASE web site</a> for more information.
36  Methods that have been tagged as <code>@deprecated</code> should be considered
37  part of the internal API and may be removed without warning in
38  a later release.
39  </p>
40
41  <p>
42  The <b>Extension API</b> is intended to be used by developers extending
43  the internal BASE functionality. The classes and interfaces in these packages
44  are not intended to be used by plug-ins or client applications.
45  </p>
46 
47  <p>
48  The <b>Internal API</b> contains code used by the internal implementation
49  of BASE. Client applications and plug-ins should not use the classes
50  and methods in theese packages.
51  </p>
52 
53  <p>
54  The <b>Mixed Public and Internal API</b> packages contains some
55  classes that belong to the <b>Public API</b> and some classes that
56  belong to the <b>Internal API</b>.
57  </p>
58 
59  <ul>
60  <li>
61    In <code>net.sf.basedb.core.data</code> the <code>BatchableData</code>
62    interface and all classes that implements it part of the public API.
63  </li>
64 
65  <li>
66    The <code>net.sf.basedb.clients.web.util.HTML</code> is part of
67    the public API.
68  </li>
69 
70  <li>
71    The <code>net.sf.basedb.clients.web.Base</code> and
72    <code>net.sf.basedb.clients.web.WebException</code> are part of
73    the public API.
74  </li>
75  </ul>
76 
77  <p>
78  All other classes in are part of the internal API.
79  </p>
80   
81</body>
Note: See TracBrowser for help on using the repository browser.