org.netbeans.modules.junit.api

Class JUnitTestUtil

java.lang.Object

org.netbeans.modules.java.testrunner.CommonTestUtil

org.netbeans.modules.junit.api.JUnitTestUtil

public class JUnitTestUtil
extends org.netbeans.modules.java.testrunner.CommonTestUtil

Method Summary

Modifier and Type	Method and Description
static boolean	areAnnotationsSupported(FileObject file) Checks whether Java annotations are applicable in the given file.
static boolean	areAnnotationsSupported(String sourceLevel) Determines whether Java annotations are supported by the given Java source level.
static boolean	canCreateTests(JUnitPlugin plugin, FileObject... fileObjects) Determines whether the given plugin is capable of creating tests for the given files at the moment.
static String	convertClass2TestName(String classFileName) Converts given class filename to test filename, e.g.
static String	convertPackage2ITSuiteName(String packageFileName) Converts given package filename to integration test suite filename, e.g.
static String	convertPackage2SuiteName(String packageFileName) Converts given package filename to test suite filename, e.g.
static String	createNewName(int i, Set usedNames)
static boolean	createTestActionCalled(JUnitPlugin plugin, FileObject[] filesToTest)
static FileObject[]	createTests(JUnitPlugin plugin, FileObject[] filesToTest, FileObject targetRoot, Map<org.netbeans.modules.gsf.testrunner.plugin.CommonPlugin.CreateTestParam,Object> params) Creates test classes for given source classes.
static ClassTree	findMainClass(CompilationInfo compInfo) Finds a main class.
static String	getIntegrationTestClassName(String sourceClassName)
static JUnitPlugin	getITPluginForProject(Project project)
static List<String>	getJavaFileNames(FileObject packageFolder, ClasspathInfo cpInfo) Returns full names of all primary Java classes withing the specified folder (non-recursive).
static JUnitPlugin	getPluginForProject(Project project)
static JUnitPlugin	getPluginForProject(Project project, JUnitVersion preferredVersion)
static String	getSimpleName(String fullName) Gets the last part of a fully qualified Java name.
static String	getSourceLevel(FileObject file) Determines source level of the given file.
static String	getTestClassFullName(String sourceClassName, String packageName)
static String	getTestClassName(String sourceClassName)
static boolean	isClassException(CompilationInfo compilationInfo, TypeElement classElem)
static boolean	isClassImplementingTestInterface(CompilationInfo compilationInfo, TypeElement classElem)
static boolean	isClassTest(CompilationInfo compilationInfo, TypeElement classElem)
static boolean	isValidPackageName(String str)
static void	notifyUser(String msg) Show error message box.
static void	notifyUser(String msg, int messageType) Show message box of the specified severity.

Methods inherited from class org.netbeans.modules.java.testrunner.CommonTestUtil

findSourceGroupOwner, findSourceGroupOwner, findSourceGroupOwners, getFileObject2SourceGroupMap, getSettingsMap, getTestTargets, isJavaFile, skipNulls

Methods inherited from class java.lang.Object

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

Method Detail

canCreateTests

public static boolean canCreateTests(JUnitPlugin plugin,
                                     FileObject... fileObjects)

Determines whether the given plugin is capable of creating tests for the given files at the moment. The default implementation returns true.

Parameters:

plugin - plugin to be queried

fileObjects - FileObjects for which the tests are about to be created

Returns:

true if the given plugin is able of creating tests for the given FileObjects, false otherwise

See Also:

JUnitTestUtil.createTests(org.netbeans.modules.junit.plugin.JUnitPlugin, org.openide.filesystems.FileObject[], org.openide.filesystems.FileObject, java.util.Map<org.netbeans.modules.gsf.testrunner.plugin.CommonPlugin.CreateTestParam, java.lang.Object>)

createTests

public static FileObject[] createTests(JUnitPlugin plugin,
                                       FileObject[] filesToTest,
                                       FileObject targetRoot,
                                       Map<org.netbeans.modules.gsf.testrunner.plugin.CommonPlugin.CreateTestParam,Object> params)

Creates test classes for given source classes.

Parameters:

filesToTest - source files for which test classes should be created

targetRoot - root folder of the target source root

params - parameters of creating test class - each key is an Integer whose value is equal to some of the constants defined in the class; the value is either a String (for key with value CLASS_NAME) or a Boolean (for other keys)

Returns:

created test files

createTestActionCalled

public static boolean createTestActionCalled(JUnitPlugin plugin,
                                             FileObject[] filesToTest)

getTestClassFullName

public static String getTestClassFullName(String sourceClassName,
                                          String packageName)

getTestClassName

public static String getTestClassName(String sourceClassName)

getIntegrationTestClassName

public static String getIntegrationTestClassName(String sourceClassName)

convertPackage2SuiteName

public static String convertPackage2SuiteName(String packageFileName)

Converts given package filename to test suite filename, e.g. "org/netbeans/foo" -> "org/netbeans/foo/{suite-prefix}Foo{suite-suffix}"

Parameters:

packageFileName - package filename in form of "org/netbeans/foo"

convertPackage2ITSuiteName

public static String convertPackage2ITSuiteName(String packageFileName)

Converts given package filename to integration test suite filename, e.g. "org/netbeans/foo" -> "org/netbeans/foo/{suite-prefix}FooIT{suite-suffix}"

Parameters:

packageFileName - package filename in form of "org/netbeans/foo"

convertClass2TestName

public static String convertClass2TestName(String classFileName)

Converts given class filename to test filename, e.g. "org/netbeans/Foo" -> "org/netbeans/{test-prefix}Foo{test-suffix}"

Parameters:

classFileName - class filename in form of "org/netbeans/Foo", i.e. without extension, no inner class

notifyUser

public static void notifyUser(String msg)

Show error message box.

notifyUser

public static void notifyUser(String msg,
                              int messageType)

Show message box of the specified severity.

isClassTest

public static boolean isClassTest(CompilationInfo compilationInfo,
                                  TypeElement classElem)

isClassImplementingTestInterface

public static boolean isClassImplementingTestInterface(CompilationInfo compilationInfo,
                                                       TypeElement classElem)

isClassException

public static boolean isClassException(CompilationInfo compilationInfo,
                                       TypeElement classElem)

findMainClass

public static ClassTree findMainClass(CompilationInfo compInfo)

Finds a main class.

Parameters:

compInfo - defines scope in which the class is to be found

Returns:

the found class; or null if the class was not found (e.g. because of a broken source file)

getJavaFileNames

public static List<String> getJavaFileNames(FileObject packageFolder,
                                            ClasspathInfo cpInfo)

Returns full names of all primary Java classes withing the specified folder (non-recursive).

Parameters:

packageFolder - folder to search

cpInfo - classpath to be used for the search

Returns:

list of full names of all primary Java classes within the specified package

createNewName

public static String createNewName(int i,
                                   Set usedNames)

isValidPackageName

public static boolean isValidPackageName(String str)

getPluginForProject

public static JUnitPlugin getPluginForProject(Project project)

getPluginForProject

public static JUnitPlugin getPluginForProject(Project project,
                                              JUnitVersion preferredVersion)

Parameters:

project -

preferredVersion -

Returns:

Since:

2.82

getITPluginForProject

public static JUnitPlugin getITPluginForProject(Project project)

getSimpleName

public static String getSimpleName(String fullName)

Gets the last part of a fully qualified Java name.

getSourceLevel

public static String getSourceLevel(FileObject file)

Determines source level of the given file.

Parameters:

file - file whose source level is to be determined

Returns:

string denoting source level of the given file (e.g. "1.5") or null if the source level could not be determined

areAnnotationsSupported

public static boolean areAnnotationsSupported(FileObject file)

Checks whether Java annotations are applicable in the given file. The result is true if source level of the given is known and the source level is 1.5 or higher.

Parameters:

file - file to be checked

Returns:

true if the given file is known to be based on JDK 1.5 or higher; false otherwise

See Also:

JUnitTestUtil.getSourceLevel(org.openide.filesystems.FileObject), JUnitTestUtil.areAnnotationsSupported(String)

areAnnotationsSupported

public static boolean areAnnotationsSupported(String sourceLevel)

Determines whether Java annotations are supported by the given Java source level.

Parameters:

sourceLevel - Java source level (e.g. "1.5"), or null if the source level is unknown

Returns:

true if the source level is known and Java annotations are supported in the source level, false otherwise

See Also:

JUnitTestUtil.areAnnotationsSupported(FileObject)