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-2007 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.web.jsf.api.facesmodel;
043:
044: import java.util.List;
045: import org.netbeans.modules.web.jsf.impl.facesmodel.JSFConfigQNames;
046:
047: /**
048: * This group keeps the usage of the contained description related
049: * elements consistent across Java EE deployment descriptors.
050: *
051: * All elements may occur multiple times with different languages,
052: * to support localization of the content.
053: *
054: * @author Petr Pisl
055: */
056: public interface DescriptionGroup {
057:
058: public static final String DESCRIPTION = JSFConfigQNames.DESCRIPTION
059: .getLocalName();
060: public static final String DISPLAY_NAME = JSFConfigQNames.DISPLAY_NAME
061: .getLocalName();
062: public static final String ICON = JSFConfigQNames.ICON
063: .getLocalName();
064:
065: /**
066: *
067: * @return
068: */
069: List<Description> getDescriptions();
070:
071: /**
072: *
073: * @param description
074: */
075: void addDescription(Description description);
076:
077: /**
078: *
079: * @param index
080: * @param description
081: */
082: void addDescription(int index, Description description);
083:
084: /**
085: *
086: * @param description
087: */
088: void removeDescription(Description description);
089:
090: /**
091: *
092: * @return
093: */
094: List<DisplayName> getDisplayNames();
095:
096: /**
097: *
098: * @param displayName
099: */
100: void addDisplayName(DisplayName displayName);
101:
102: /**
103: *
104: * @param index
105: * @param displayName
106: */
107: void addDisplayName(int index, DisplayName displayName);
108:
109: /**
110: *
111: * @param displayName
112: */
113: void removeDisplayName(DisplayName displayName);
114:
115: /**
116: *
117: * @return
118: */
119: List<Icon> getIcons();
120:
121: /**
122: *
123: * @param icon
124: */
125: void addIcon(Icon icon);
126:
127: void addIcon(int index, Icon icon);
128:
129: void removeIcon(Icon icon);
130: }
|