KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > java > plugin > registry > PluginAttribute


1 /*****************************************************************************
2  * Java Plug-in Framework (JPF)
3  * Copyright (C) 2004-2005 Dmitry Olshansky
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *****************************************************************************/

19 package org.java.plugin.registry;
20
21 import java.util.Collection JavaDoc;
22
23 /**
24  * This interface abstracts plug-in attribute, a <ID,VALUE> pair. Plug-in
25  * attributes are not involved into JPF runtime internal logic and intended
26  * to be used by plug-in developers.
27  * @version $Id: PluginAttribute.java,v 1.1 2005/07/20 18:43:46 ddimon Exp $
28  */

29 public interface PluginAttribute extends PluginElement {
30     /**
31      * @return attribute value as it is specified in manifest
32      */

33     String JavaDoc getValue();
34
35     /**
36      * @return collection of all sub-attributes of this attribute
37      */

38     Collection JavaDoc getSubAttributes();
39
40     /**
41      * @param id ID of sub-attribute to look for
42      * @return sub-attribute with given ID
43      */

44     PluginAttribute getSubAttribute(String JavaDoc id);
45
46     /**
47      * @param id ID of sub-attribute to look for
48      * @return collection of all sub-attributes with given ID
49      */

50     Collection JavaDoc getSubAttributes(String JavaDoc id);
51     
52     /**
53      * @return attribute, of which this one is child or <code>null</code> if
54      * this is top level attribute
55      */

56     PluginAttribute getSuperAttribute();
57 }
58
Popular Tags