1 /*$Id: ComponentDescriptor.java,v 1.1 2004/05/04 11:00:12 nw Exp $
2 * Created on 06-Mar-2004
3 *
4 * Copyright (C) AstroGrid. All rights reserved.
5 *
6 * This software is published under the terms of the AstroGrid
7 * Software License version 1.2, a copy of which has been included
8 * with this distribution in the LICENSE.txt file.
9 *
10 **/
11 package org.astrogrid.component.descriptor;
12
13 import junit.framework.Test;
14
15 /*** An interface that components should implement to be self-documenting
16 * <p>
17 * Note that although it's nice for components to implement this interface, it is not mandatory - hence none of the component interfaces extend this one.
18 * @author Noel Winstanley nw@jb.man.ac.uk 06-Mar-2004
19 *
20 */
21 public interface ComponentDescriptor {
22
23 /*** full name for the component */
24 String getName();
25 /*** formatted description of the component, (with maybe details of current configuration */
26 String getDescription();
27 /*** Access a junit test suite that when run will verify that the component instance and configured correctly
28 * <p>
29 * may return null if no tests are applicable. */
30 Test getInstallationTest() ;
31
32 }
33
34
35 /*
36 $Log: ComponentDescriptor.java,v $
37 Revision 1.1 2004/05/04 11:00:12 nw
38 moved pico-container component stuff from jes into common, so it can be used in cea too
39
40 Revision 1.2 2004/03/15 23:45:07 nw
41 improved javadoc
42
43 Revision 1.1 2004/03/15 01:30:06 nw
44 factored component descriptor out into separate package
45
46 Revision 1.2 2004/03/07 21:04:38 nw
47 merged in nww-itn05-pico - adds picocontainer
48
49 Revision 1.1.2.1 2004/03/07 20:39:47 nw
50 reimplemented component-manager framework to use picocontainer
51
52 */