org.netbeans.modules.junit.api

Class JUnitUtils

java.lang.Object

org.netbeans.modules.junit.api.JUnitUtils

public final class JUnitUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	TESTS_ROOT_NAME

Constructor Summary

Constructors

Constructor and Description
JUnitUtils(Project project)

Method Summary

Modifier and Type	Method and Description
static DataObject	createSuiteTest(FileObject targetRootFolder, FileObject targetFolder, String suiteName, Map<org.netbeans.modules.gsf.testrunner.plugin.CommonPlugin.CreateTestParam,Object> params)
SourceGroup[]	getJavaSourceGroups()
Project	getProject()
FileObject[]	getSourceFoldersRaw(FileObject testFolder) Returns an array of source folders corresponding to the given test folder - may contain nulls.
Map<SourceGroup,Object[]>	getSourcesToTestsMap(boolean sourceGroupsOnly)
static Collection<FileObject>	getTestFolders(Project project) Identifies and collects root test folders of a given project.
FileObject[]	getTestFoldersRaw(FileObject srcFolder) Returns an array of test folders corresponding to the given source folder - may contain nulls.
static Collection	getTestTargets(Project project, boolean sourceGroupsOnly) Identifies and collects SourceGroups and folders of a given project which may serve as target folders for newly created test classes.
Object[]	getTestTargets(SourceGroup sourceGroup, boolean sourceGroupsOnly) Returns test targets for the given SourceGroup.
static boolean	isInstanceOfDefaultPlugin(JUnitPlugin plugin)
static boolean	isValidClassName(String className)
static void	logJUnitUsage(URI projectURI)
static FileObject[]	skipNulls(FileObject[] fileObjs)

Methods inherited from class java.lang.Object

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

Field Detail

TESTS_ROOT_NAME

public static final String TESTS_ROOT_NAME

See Also:

Constant Field Values

Constructor Detail

JUnitUtils

public JUnitUtils(Project project)

Method Detail

logJUnitUsage

public static void logJUnitUsage(URI projectURI)

isInstanceOfDefaultPlugin

public static boolean isInstanceOfDefaultPlugin(JUnitPlugin plugin)

createSuiteTest

public static DataObject createSuiteTest(FileObject targetRootFolder,
                                         FileObject targetFolder,
                                         String suiteName,
                                         Map<org.netbeans.modules.gsf.testrunner.plugin.CommonPlugin.CreateTestParam,Object> params)

getTestTargets

public static Collection getTestTargets(Project project,
                                        boolean sourceGroupsOnly)

Identifies and collects SourceGroups and folders of a given project which may serve as target folders for newly created test classes.

Parameters:

project - project whose folders are to be checked

sourceGroupsOnly - return only SourceGroups - ignore target folders not having a corresponding SourceGroup

Returns:

collection which may contain FileObjects or SourceGroups (or both); it may be empty but not null

getTestFolders

public static Collection<FileObject> getTestFolders(Project project)

Identifies and collects root test folders of a given project.

Parameters:

project - project whose test folders are to be found

Returns:

collection of found FileObjects, possibly empty (but not null)

getProject

public Project getProject()

getSourcesToTestsMap

public Map<SourceGroup,Object[]> getSourcesToTestsMap(boolean sourceGroupsOnly)

getTestTargets

public Object[] getTestTargets(SourceGroup sourceGroup,
                               boolean sourceGroupsOnly)

Returns test targets for the given SourceGroup. The test targets are folders which are searched when tests for a class from the SourceGroup are to be found. Each of the returned test targets may be either SourceGroup (representing a folder plus additional information such as display name) or simply a FileObject representing a folder. If parameter includeSourceGroups is false, only SourceGroups are returned (target folders without corresponding SourceGroups are ignored).

Parameters:

sourceGroup - source group to find test targets for

sourceGroupsOnly - skip target folders without matching SourceGroup

Returns:

array which may contain FileObjects or SourceGroups (or both); it may be empty but not null

See Also:

CommonTestUtil.getFileObject2SourceGroupMap(org.netbeans.api.project.Project)

getTestFoldersRaw

public FileObject[] getTestFoldersRaw(FileObject srcFolder)

Returns an array of test folders corresponding to the given source folder - may contain nulls.

Parameters:

srcFolder - FileObject representing source code root, for which test root folders should be found

Returns:

array of FileObjects representing test root folders, possibly with superfluous null elements

See Also:

JUnitUtils.getSourceFoldersRaw(org.openide.filesystems.FileObject)

getSourceFoldersRaw

public FileObject[] getSourceFoldersRaw(FileObject testFolder)

Returns an array of source folders corresponding to the given test folder - may contain nulls.

Parameters:

testFolder - FileObject representing source code root, for which source root folders should be found

Returns:

array of FileObjects representing source root folders, possibly with superfluous null elements

See Also:

JUnitUtils.getTestFoldersRaw(org.openide.filesystems.FileObject)

skipNulls

public static FileObject[] skipNulls(FileObject[] fileObjs)

getJavaSourceGroups

public SourceGroup[] getJavaSourceGroups()

isValidClassName

public static boolean isValidClassName(String className)