KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > resolver > api > PropertyResolver


1 /*====================================================================
2
3 Objectweb Explorer Framework
4 Copyright (C) 2000-2004 INRIA - USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Jerome Moroy, Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26 package org.objectweb.util.explorer.resolver.api;
27
28 import org.objectweb.util.explorer.api.Entry;
29 import org.objectweb.util.explorer.core.common.api.Description;
30
31 /**
32  * This interface is used to resolve a property for an entry.
33  *
34  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>,
35  * <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>.
36  *
37  * @version 0.1
38  */
39 public interface PropertyResolver {
40
41     /** The name of the fractal interface reference. */
42     public static String JavaDoc PROPERTY_RESOLVER = "property-resolver";
43
44     /**
45      * This interface is used to provide a description of the given property type
46      * for the given entry.
47      *
48      * This method doesn't modify the given parameters.
49      *
50      * @param propertyType The type of property. The available types are:
51      * <ul>
52      * <li>ExplorerConstants.ICON_PROPERTY for defining icon.</li>
53      * <li>ExplorerConstants.MENU_PROPERTY for defining menu.</li>
54      * <li>ExplorerConstants.INFO_PROPERTY for defining info.</li>
55      * </ul>
56      * @param currentEntry The current entry.
57      * @param parentEntry The parent entry of the given entry.
58      *
59      * @return The associated description or null if no description is found.
60      */
61     public Description resolve(String JavaDoc propertyType, Entry currentEntry, Entry parentEntry);
62         
63     /**
64      * This interface is used to provide a description of the given property type
65      * for the given entry.
66      *
67      * This method doesn't modify the given parameters.
68      *
69      * @param propertyType The type of property. The available types are:
70      * <ul>
71      * <li>ExplorerConstants.ICON_PROPERTY for defining icon.</li>
72      * <li>ExplorerConstants.MENU_PROPERTY for defining menu.</li>
73      * <li>ExplorerConstants.INFO_PROPERTY for defining info.</li>
74      * </ul>
75      * @param currentEntry The current entry.
76      *
77      * @return The associated description or null if no description is found.
78      */
79     public Description resolve(String JavaDoc propertyType, Entry currentEntry);
80     
81 }
82
Popular Tags