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: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.ant.freeform.spi;
43:
44: /**
45: * This interface is used to compute the help context for a freeform project.
46: * Each {@link ProjectNature} should register an implementation in its lookup.
47: * See {@link #getHelpIDFragment} to find out what are the requirements on the help
48: * id fragments.
49: *
50: * If it is necessary to compute a help context for a freeform project, all
51: * {@link HelpIDFragmentProvider}s registered in the project's lookup are asked to
52: * provide the fragments. The fragments are then lexicographically sorted and
53: * concatenated (separated by dots) into one string, used as a base for the help id.
54: *
55: * @author Jan Lahoda
56: * @since 1.11.1
57: */
58: public interface HelpIDFragmentProvider {
59:
60: /**
61: * Returns a help id fragment defined by the implementor. The method should return
62: * the same string each time it is called (more preciselly, it is required that
63: * <code>getHelpIDFragment().equals(getHelpIDFragment())</code>, but is allowed to
64: * <code>getHelpIDFragment() != getHelpIDFragment()</code>). The string should be unique
65: * among all the freeform project natures. The string is required to match this
66: * regular expression: <code>([A-Za-z0-9])+</code>.
67: *
68: * Please note that the returned fragment is part of the contract between the
69: * code and documentation, so be carefull when you need to change it.
70: *
71: * @return a non-null help id fragment, fullfilling the above conditions.
72: */
73: public String getHelpIDFragment();
74:
75: }
|