KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > web > dd > common > DescriptionInterface


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.api.web.dd.common;
21 /**
22  * Super interface for all DD elements having the description property/properties.
23  *
24  *<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>
25  *</p>
26  *
27  * @deprecated Use the API for web module deployment descriptor in j2ee/ddapi module.
28  * @author Milan Kuchtiak
29  */
30 public interface DescriptionInterface {
31
32     /**
33      * Sets the description element for particular locale.<br>
34      * If locale=null the method sets the description element without xml:lang attribute.<br>
35      * If description=null method removes the description element for a specified locale.<br>
36      *
37      * @param locale string representing the locale - the value for xml:lang attribute e.g. "fr"
38      * @param description value for description element
39      */
40     public void setDescription(String JavaDoc locale, String JavaDoc description) throws VersionNotSupportedException;
41     
42     /**
43      * Sets the description element without xml:lang attribute.
44      *
45      * @param description value for description element
46      */
47     public void setDescription(String JavaDoc description);
48
49     /**
50      * Sets the multiple description elements.
51      *
52      * @param descriptions Map of descriptions in the form of [locale,description]
53      */
54     public void setAllDescriptions(java.util.Map JavaDoc descriptions) throws VersionNotSupportedException;
55     
56     /**
57      * Returns the description element value for particular locale.<br>
58      * If locale=null method returns description for default locale.
59      *
60      * @param locale string representing the locale - the value of xml:lang attribute e.g. "fr".
61      * @return description element value or null if not specified for given locale
62      */
63     public String JavaDoc getDescription(String JavaDoc locale) throws VersionNotSupportedException;
64
65     /**
66      * Returns the description element value for default locale.
67      *
68      * @return description element value or null if not specified for default locale
69      */
70     public String JavaDoc getDefaultDescription();
71
72     /**
73      * Returns all description elements in the form of <@link java.util.Map>.
74      *
75      * @return map of all descriptions in the form of [locale:description]
76      */
77     public java.util.Map JavaDoc getAllDescriptions();
78     
79     /**
80      * Removes the description element for particular locale.
81      * If locale=null the method removes the description element for default locale.
82      *
83      * @param locale string representing the locale - the value of xml:lang attribute e.g. "fr"
84      */
85     public void removeDescriptionForLocale(String JavaDoc locale) throws VersionNotSupportedException;
86     
87     /**
88      * Removes description element for default locale.
89      */
90     public void removeDescription();
91     
92     /**
93      * Removes all description elements from DD element.
94      */
95     public void removeAllDescriptions();
96
97 }
98
Popular Tags