| org.netbeans.modules.ant.freeform.spi.HelpIDFragmentProvider
HelpIDFragmentProvider | public interface HelpIDFragmentProvider (Code) | | This interface is used to compute the help context for a freeform project.
Each
ProjectNature should register an implementation in its lookup.
See
HelpIDFragmentProvider.getHelpIDFragment to find out what are the requirements on the help
id fragments.
If it is necessary to compute a help context for a freeform project, all
HelpIDFragmentProvider s registered in the project's lookup are asked to
provide the fragments. The fragments are then lexicographically sorted and
concatenated (separated by dots) into one string, used as a base for the help id.
author: Jan Lahoda since: 1.11.1 |
getHelpIDFragment | public String getHelpIDFragment()(Code) | | Returns a help id fragment defined by the implementor. The method should return
the same string each time it is called (more preciselly, it is required that
getHelpIDFragment().equals(getHelpIDFragment()) , but is allowed to
getHelpIDFragment() != getHelpIDFragment() ). The string should be unique
among all the freeform project natures. The string is required to match this
regular expression: ([A-Za-z0-9])+ .
Please note that the returned fragment is part of the contract between the
code and documentation, so be carefull when you need to change it.
a non-null help id fragment, fullfilling the above conditions. |
|
|