01: /* ========================================================================
02: * JCommon : a free general purpose class library for the Java(tm) platform
03: * ========================================================================
04: *
05: * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
06: *
07: * Project Info: http://www.jfree.org/jcommon/index.html
08: *
09: * This library is free software; you can redistribute it and/or modify it
10: * under the terms of the GNU Lesser General Public License as published by
11: * the Free Software Foundation; either version 2.1 of the License, or
12: * (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful, but
15: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
17: * License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22: * USA.
23: *
24: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
25: * in the United States and other countries.]
26: *
27: * ---------------
28: * ModuleInfo.java
29: * ---------------
30: * (C)opyright 2004, by Thomas Morgner and Contributors.
31: *
32: * Original Author: Thomas Morgner;
33: * Contributor(s): David Gilbert (for Object Refinery Limited);
34: *
35: * $Id: ModuleInfo.java,v 1.3 2005/10/18 13:14:50 mungady Exp $
36: *
37: * Changes
38: * -------
39: * 07-Jun-2004 : Added JCommon header (DG);
40: *
41: */
42:
43: package org.jfree.base.modules;
44:
45: /**
46: * The Module info class encapsulates metadata about a given module. It holds the
47: * list of dependencies and the module version and description.
48: *
49: * @author Thomas Morgner
50: */
51: public interface ModuleInfo {
52:
53: /**
54: * Returns the module class of the desired base module.
55: *
56: * @return The module class.
57: */
58: public String getModuleClass();
59:
60: /**
61: * Returns the major version of the base module. The string should
62: * contain a compareable character sequence so that higher versions
63: * of the module are considered greater than lower versions.
64: *
65: * @return The major version of the module.
66: */
67: public String getMajorVersion();
68:
69: /**
70: * Returns the minor version of the base module. The string should
71: * contain a compareable character sequence so that higher versions
72: * of the module are considered greater than lower versions.
73: *
74: * @return The minor version of the module.
75: */
76: public String getMinorVersion();
77:
78: /**
79: * Returns the patchlevel version of the base module. The patch level
80: * should be used to mark bugfixes. The string should
81: * contain a compareable character sequence so that higher versions
82: * of the module are considered greater than lower versions.
83: *
84: * @return The patch level version of the module.
85: */
86: public String getPatchLevel();
87:
88: }
|