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.deployment.common.api;
043
044 import java.beans.Customizer;
045 import org.netbeans.spi.project.libraries.LibraryImplementation;
046 import org.netbeans.spi.project.libraries.LibraryTypeProvider;
047 import org.netbeans.spi.project.libraries.support.LibrariesSupport;
048 import org.openide.util.Lookup;
049 import org.openide.util.NbBundle;
050
051 /**
052 * The J2eeLibraryTypeProvider defines a j2ee library type and is responsible for
053 * creating new libraries of this type.
054 *
055 * @author Stepan Herold
056 * @since 1.5
057 */
058 public final class J2eeLibraryTypeProvider implements
059 LibraryTypeProvider {
060
061 /** J2ee library type */
062 public static final String LIBRARY_TYPE = "j2ee"; //NOI18N
063
064 /** Classpath volume type */
065 public static final String VOLUME_TYPE_CLASSPATH = "classpath"; //NOI18N
066 /** Source volume type */
067 public static final String VOLUME_TYPE_SRC = "src"; //NOI18N
068 /** Javadoc volume type */
069 public static final String VOLUME_TYPE_JAVADOC = "javadoc"; //NOI18N
070
071 public static final String[] VOLUME_TYPES = new String[] {
072 VOLUME_TYPE_CLASSPATH, VOLUME_TYPE_SRC, VOLUME_TYPE_JAVADOC };
073
074 /** Creates a new instance of J2eeLibraryTypeProvider */
075 public J2eeLibraryTypeProvider() {
076 }
077
078 /**
079 * Returns the UI name of the LibraryType.
080 * This name is used in the UI while the libraryType is used as a system
081 * identifier.
082 * @return String the display name
083 */
084 public String getDisplayName() {
085 return NbBundle.getMessage(J2eeLibraryTypeProvider.class,
086 "TXT_J2eeLibraryType"); //NOI18N
087 }
088
089 /**
090 * Get a j2ee library type identifier.
091 *
092 * @return the j2ee library type identifier.
093 */
094 public String getLibraryType() {
095 return LIBRARY_TYPE;
096 }
097
098 /**
099 * Return supported volume types: <code>classpath</code>, <code>javadoc</code>,
100 * <code>src</code>.
101 *
102 * @return support volume types.
103 */
104 public String[] getSupportedVolumeTypes() {
105 return VOLUME_TYPES;
106 }
107
108 /**
109 * Creates a new implementation of j2ee library type.
110 *
111 * @return the created library model, never null
112 */
113 public LibraryImplementation createLibrary() {
114 return LibrariesSupport.createLibraryImplementation(
115 LIBRARY_TYPE, VOLUME_TYPES);
116 }
117
118 /**
119 * Does nothing now.
120 */
121 public void libraryDeleted(LibraryImplementation libraryImpl) {
122 }
123
124 /**
125 * Does nothing now.
126 */
127 public void libraryCreated(LibraryImplementation libraryImpl) {
128 }
129
130 /**
131 * Currently returns <code>null</code>.
132 */
133 public Customizer getCustomizer(String volumeType) {
134 return null;
135 }
136
137 /**
138 * Returns empty lookup.
139 * @return empty lookup.
140 */
141 public Lookup getLookup() {
142 return Lookup.EMPTY;
143 }
144 }
|