01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * Portions Copyrighted 2007 Sun Microsystems, Inc.
27: */
28: package org.netbeans.modules.web.spi.webmodule;
29:
30: import org.netbeans.modules.web.api.webmodule.WebModule;
31:
32: /**
33: * List of templates which should be in the initial "privileged" list
34: * when creating a new file. An instance should be placed in the
35: * <code>j2ee/webtier/templates</code> folder in a module layer.
36: *
37: * @author Petr Pisl
38: */
39: public interface WebPrivilegedTemplates {
40:
41: /**
42: * Returns the list of templates which should be added in the initial "privileged" list
43: * when created a new file.
44: *
45: * @param webModule the web module to return the templates for.
46: * For example, it can be used to find out whether the web module is extended
47: * by a framework and then appropriate templates for the framework can be offered
48: * in the list of privileged list of templates.
49: *
50: * @return full paths to privileged templates, e.g. <samp>Templates/Other/XmlFile.xml</samp>; never null.
51: */
52: public String[] getPrivilegedTemplates(WebModule webModule);
53: }
|