001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.j2ee.dd.api.common;
043:
044: /**
045: * Super interface for all DD elements having the display-name property/properties.
046: *
047: *<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>
048: *</p>
049: *
050: * @author Milan Kuchtiak
051: */
052: public interface DisplayNameInterface {
053:
054: /**
055: * Sets the display-name element value for particular locale.<br>
056: * If locale=null the method sets the display-name element without xml:lang attribute.<br>
057: * If displayName=null method removes the display-name element for a specified locale.<br>
058: *
059: * @param locale string representing the locale - the value for xml:lang attribute e.g. "fr"
060: * @param displayName value for display-name element
061: */
062: public void setDisplayName(String locale, String displayName)
063: throws VersionNotSupportedException;
064:
065: /**
066: * Sets the display-name element without xml:lang attribute.
067: *
068: * @param displayName value for display-name element
069: */
070: public void setDisplayName(String displayName);
071:
072: /**
073: * Sets the multiple display-name elements.
074: *
075: * @param displayNames Map of display names in the form of [locale,display-name]
076: */
077: public void setAllDisplayNames(java.util.Map displayNames)
078: throws VersionNotSupportedException;
079:
080: /**
081: * Returns the display-name element value for particular locale.<br>
082: * If locale=null method returns display-name for default locale.
083: *
084: * @param locale string representing the locale - the value of xml:lang attribute e.g. "fr".
085: * @return display-name element value or null if not specified for given locale
086: */
087: public String getDisplayName(String locale)
088: throws VersionNotSupportedException;
089:
090: /**
091: * Returns the display-name element value for default locale.
092: *
093: * @return display-name element value or null if not specified for default locale
094: */
095: public String getDefaultDisplayName();
096:
097: /**
098: * Returns all display-name elements in the form of <@link java.util.Map>.
099: *
100: * @return map of all display-names in the form of [locale:display-name]
101: */
102: public java.util.Map getAllDisplayNames();
103:
104: /**
105: * Removes the display-name element for particular locale.
106: * If locale=null the method removes the display-name element for default locale.
107: *
108: * @param locale string representing the locale - the value of xml:lang attribute e.g. "fr"
109: */
110: public void removeDisplayNameForLocale(String locale)
111: throws VersionNotSupportedException;
112:
113: /**
114: * Removes display-name element for default locale.
115: */
116: public void removeDisplayName();
117:
118: /**
119: * Removes all display-name elements from DD element.
120: */
121: public void removeAllDisplayNames();
122: }
|