KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > dd > api > common > FindCapability


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.j2ee.dd.api.common;
21
22 /**
23  * Ability to find an instance of CommonDDBean class nested inside this bean.
24  *
25  *<p><b><font color="red"><em>Important note: Do not provide an implementation of this interface unless you are a DD API provider!</em></font></b>
26  *</p>
27  *
28  * @author Milan Kuchtiak
29  */
30 public interface FindCapability {
31
32     /**
33      * Method is looking for the nested DD element according to the specified property and value
34      *
35      * @param beanName e.g. "Servlet" or "ResourceRef"
36      * @param propertyName e.g. "ServletName" or ResourceRefName"
37      * @param value specific propertyName value e.g. "ControllerServlet" or "jdbc/EmployeeAppDb"
38      * @return Bean satisfying the parameter values or null if not found
39      */
40     public CommonDDBean findBeanByName(String JavaDoc beanName, String JavaDoc propertyName, String JavaDoc value);
41 }
42
Popular Tags