public abstract class

ProfileValueUtils

extends Object
java.lang.Object
   ↳ org.springframework.test.annotation.ProfileValueUtils

Class Overview

General utility methods for working with profile values.

See Also

Summary

Public Constructors
ProfileValueUtils()
Public Methods
static boolean isTestEnabledInThisEnvironment(Class<?> testClass)
Determine if the supplied testClass is enabled in the current environment, as specified by the @IfProfileValue annotation at the class level.
static boolean isTestEnabledInThisEnvironment(ProfileValueSource profileValueSource, Method testMethod, Class<?> testClass)
Determine if the supplied testMethod is enabled in the current environment, as specified by the @IfProfileValue annotation, which may be declared on the test method itself or at the class level.
static boolean isTestEnabledInThisEnvironment(Method testMethod, Class<?> testClass)
Determine if the supplied testMethod is enabled in the current environment, as specified by the @IfProfileValue annotation, which may be declared on the test method itself or at the class level.
static ProfileValueSource retrieveProfileValueSource(Class<?> testClass)
Retrieves the ProfileValueSource type for the specified test class as configured via the @ProfileValueSourceConfiguration annotation and instantiates a new instance of that type.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ProfileValueUtils ()

Public Methods

public static boolean isTestEnabledInThisEnvironment (Class<?> testClass)

Determine if the supplied testClass is enabled in the current environment, as specified by the @IfProfileValue annotation at the class level.

Defaults to true if no @IfProfileValue annotation is declared.

Parameters
testClass the test class
Returns
  • true if the test is enabled in the current environment

public static boolean isTestEnabledInThisEnvironment (ProfileValueSource profileValueSource, Method testMethod, Class<?> testClass)

Determine if the supplied testMethod is enabled in the current environment, as specified by the @IfProfileValue annotation, which may be declared on the test method itself or at the class level. Class-level usage overrides method-level usage.

Defaults to true if no @IfProfileValue annotation is declared.

Parameters
profileValueSource the ProfileValueSource to use to determine if the test is enabled
testMethod the test method
testClass the test class
Returns
  • true if the test is enabled in the current environment

public static boolean isTestEnabledInThisEnvironment (Method testMethod, Class<?> testClass)

Determine if the supplied testMethod is enabled in the current environment, as specified by the @IfProfileValue annotation, which may be declared on the test method itself or at the class level. Class-level usage overrides method-level usage.

Defaults to true if no @IfProfileValue annotation is declared.

Parameters
testMethod the test method
testClass the test class
Returns
  • true if the test is enabled in the current environment

public static ProfileValueSource retrieveProfileValueSource (Class<?> testClass)

Retrieves the ProfileValueSource type for the specified test class as configured via the @ProfileValueSourceConfiguration annotation and instantiates a new instance of that type.

If @ProfileValueSourceConfiguration is not present on the specified class or if a custom ProfileValueSource is not declared, the default SystemProfileValueSource will be returned instead.

Parameters
testClass The test class for which the ProfileValueSource should be retrieved
Returns
  • the configured (or default) ProfileValueSource for the specified class
See Also