org.netbeans.modules.java.api.common

Class ModuleRoots

java.lang.Object

org.netbeans.modules.java.api.common.Roots

org.netbeans.modules.java.api.common.SourceRoots

org.netbeans.modules.java.api.common.ModuleRoots

public final class ModuleRoots
extends SourceRoots

Represents a project module roots. It can be used to obtain module roots as Ant properties, FileObject's or URLs. This class is thread safe and listens to the changes in Ant project metadata (see SourceRoots.PROP_ROOT_PROPERTIES) as well as in project properties (see SourceRoots.PROP_ROOTS).

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MODULE_LABEL Default label for sources node used in LogicalViewProvider.
static String	DEFAULT_TEST_MODULE_LABEL Default label for sources node used in LogicalViewProvider.

Fields inherited from class org.netbeans.modules.java.api.common.SourceRoots

DEFAULT_SOURCE_LABEL, DEFAULT_TEST_LABEL, PROP_ROOT_PROPERTIES, PROP_ROOTS

Method Summary

Modifier and Type	Method and Description
static ModuleRoots	create(UpdateHelper helper, PropertyEvaluator evaluator, ReferenceHelper refHelper, String projectConfigurationNamespace, String elementName, boolean isTest, String newRootNameTemplate)
String	createInitialDisplayName(File sourceRoot) Creates initial display name of source/test root.
String	createInitialPath() Creates initial path of module root.
String	getRootDisplayName(String rootName, String propName) Translates root name into display name of source/test root.
String	getRootPath(String rootPathProperty)
String[]	getRootPathProperties()
URL[]	getRootURLs(boolean removeInvalidRoots) Returns the source roots as URLs.
void	putModuleRoots(URL[] roots, String[] paths) Replaces the current module roots by the given ones.

Methods inherited from class org.netbeans.modules.java.api.common.SourceRoots

getRootDisplayNames, getRootNames, getRootProperties, getRoots, getRootURLs, isTest, putRoots

Methods inherited from class org.netbeans.modules.java.api.common.Roots

addPropertyChangeListener, nonSourceRoots, propertyBased, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MODULE_LABEL

public static final String DEFAULT_MODULE_LABEL

Default label for sources node used in LogicalViewProvider.

DEFAULT_TEST_MODULE_LABEL

public static final String DEFAULT_TEST_MODULE_LABEL

Default label for sources node used in LogicalViewProvider.

Method Detail

create

public static ModuleRoots create(UpdateHelper helper,
                                 PropertyEvaluator evaluator,
                                 ReferenceHelper refHelper,
                                 String projectConfigurationNamespace,
                                 String elementName,
                                 boolean isTest,
                                 String newRootNameTemplate)

getRootPathProperties

public String[] getRootPathProperties()

getRootURLs

public URL[] getRootURLs(boolean removeInvalidRoots)

Description copied from class: SourceRoots

Returns the source roots as URLs.

Overrides:

getRootURLs in class SourceRoots

Parameters:

removeInvalidRoots - when true the URLs pointing to existing non folder roots are removed.

Returns:

an array of URL.

putModuleRoots

public void putModuleRoots(URL[] roots,
                           String[] paths)

Replaces the current module roots by the given ones.

Parameters:

roots - the URLs of the new roots.

paths - the paths of the new roots.

getRootDisplayName

public String getRootDisplayName(String rootName,
                                 String propName)

Description copied from class: SourceRoots

Translates root name into display name of source/test root.

Overrides:

getRootDisplayName in class SourceRoots

Parameters:

rootName - the name of root got from SourceRoots.getRootNames().

propName - the name of a property the root is stored in.

Returns:

the label to be displayed.

createInitialDisplayName

public String createInitialDisplayName(File sourceRoot)

Description copied from class: SourceRoots

Creates initial display name of source/test root.

Overrides:

createInitialDisplayName in class SourceRoots

Parameters:

sourceRoot - the source root.

Returns:

the label to be displayed.

getRootPath

public String getRootPath(String rootPathProperty)

createInitialPath

public String createInitialPath()

Creates initial path of module root.

Returns:

the path.