Module tech.units.tck

Package tech.units.tck.util

Class TestUtils

java.lang.Object

tech.units.tck.util.TestUtils

@Singleton
public class TestUtils
extends Object

Test utilities used in the JSR 385 TCK.

Since:

1.0

Version:

2.7, October 4, 2023

Author:

Werner Keil

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_NO_TCK_CONFIG	Global message for missing TCK Configuration
static final int	NUM_OF_BINARY_PREFIXES	Number of binary prefixes
static final int	NUM_OF_METRIC_PREFIXES	Number of metric (SI) prefixes
static final int	NUM_OF_PREFIX_TYPES	Number of built-in API prefix types
static final String	SYS_PROPERTY_OUTPUT_DIR	Name of the system property to override the default output directory
static final String	SYS_PROPERTY_PROFILE	Name of the system property to pass the desired profile
static final String	SYS_PROPERTY_REPORT_FILE	Name of the system property to override the default report file
static final String	SYS_PROPERTY_VERBOSE	Name of the system property to set the verbose flag

Method Summary

Modifier and Type	Method	Description
static void	assertValue(String section, Object value, String methodName, Object instance)	Checks the returned value, when calling a given method.
static void	testComparable(String section, Class<?> type)	Tests if the given type is Comparable.
static void	testHasNotPublicMethod(String section, Class<?> type, Class<?> returnType, String name, Class<?>... paramTypes)	Tests if the given type has not a public method with the given signature.
static void	testHasPublicMethod(String section, Class<?> type, boolean trySuperclassFirst, Class<?> returnType, String name, Class<?>... paramTypes)
static void	testHasPublicMethod(String section, Class<?> type, Class<?> returnType, String name, Class<?>... paramTypes)
static void	testHasPublicMethod(String section, Class<?> type, String name)
static void	testHasPublicMethod(String section, Class<?> type, String name, boolean hasParameters)	Tests if the given type has a public method with the given signature.
static void	testImmutable(String section, Class<?> type)	Deprecated. This was never used by the TCK, as immutability is highly recommended, but not enforced.
static boolean	testImmutableOpt(String section, Class type)	Deprecated. This was never used by the TCK, as immutability is highly recommended, but not enforced.
static void	testImplementsInterface(String section, Class<?> type, Class<?> iface)	Tests the given class implements a given interface.
static void	testSerializable(String section, Class<?> type)	Tests the given object being Serializable.
static void	testSerializable(String section, Object o)	Tests the given object being (effectively) serializable by serializing it.
static boolean	testSerializableOpt(String section, Class type)	Test for serializable (optional recommendation), writes a warning if not given.
static boolean	testSerializableOpt(String section, Object instance)	Test for serializable (optional recommendation), writes a warning if not given.

Methods inherited from class java.lang.Object

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

Field Details

SYS_PROPERTY_PROFILE

public static final String SYS_PROPERTY_PROFILE

Name of the system property to pass the desired profile

See Also:

• Constant Field Values

SYS_PROPERTY_OUTPUT_DIR

public static final String SYS_PROPERTY_OUTPUT_DIR

Name of the system property to override the default output directory

See Also:

• Constant Field Values

SYS_PROPERTY_REPORT_FILE

public static final String SYS_PROPERTY_REPORT_FILE

Name of the system property to override the default report file

See Also:

• Constant Field Values

SYS_PROPERTY_VERBOSE

public static final String SYS_PROPERTY_VERBOSE

Name of the system property to set the verbose flag

See Also:

• Constant Field Values

NUM_OF_PREFIX_TYPES

public static final int NUM_OF_PREFIX_TYPES

Number of built-in API prefix types

See Also:

• Constant Field Values

NUM_OF_BINARY_PREFIXES

public static final int NUM_OF_BINARY_PREFIXES

Number of binary prefixes

See Also:

• Constant Field Values

NUM_OF_METRIC_PREFIXES

public static final int NUM_OF_METRIC_PREFIXES

Number of metric (SI) prefixes

See Also:

• Constant Field Values

MSG_NO_TCK_CONFIG

public static final String MSG_NO_TCK_CONFIG

Global message for missing TCK Configuration

See Also:

• Constant Field Values

Method Details

testSerializable

public static void testSerializable(String section,
 Class<?> type)

Tests the given object being Serializable.

Parameters:

section - the section of the spec under test

type - the type to be checked.

Throws:

TCKValidationException - if the test fails.

testSerializable

public static void testSerializable(String section,
 Object o)

Tests the given object being (effectively) serializable by serializing it.

Parameters:

section - the section of the spec under test

o - the object to be checked.

Throws:

TCKValidationException - if test fails.

testSerializableOpt

public static boolean testSerializableOpt(String section,
 Class type)

Test for serializable (optional recommendation), writes a warning if not given.

Parameters:

section - the section of the spec under test

type - the type to be checked.

Returns:

true, if the type is probably serializable.

testSerializableOpt

public static boolean testSerializableOpt(String section,
 Object instance)

Test for serializable (optional recommendation), writes a warning if not given.

Parameters:

section - the section of the spec under test

instance - the object to be checked.

Returns:

true, if the instance is probably serializable.

testImplementsInterface

public static void testImplementsInterface(String section,
 Class<?> type,
 Class<?> iface)

Tests the given class implements a given interface.

Parameters:

section - the section of the spec under test

type - the type to be checked.

iface - the interface to be checked for. Triggers Assert#fail if test fails.

testComparable

public static void testComparable(String section,
 Class<?> type)

Tests if the given type is Comparable.

Parameters:

section - the section of the spec under test

type - the type to be checked.

Throws:

TCKValidationException - if the test fails.

testHasPublicMethod

public static void testHasPublicMethod(String section,
 Class<?> type,
 Class<?> returnType,
 String name,
 Class<?>... paramTypes)

Parameters:

section - the section of the specification

type - the type to be checked.

returnType - the expected return type

name - the name of the method

paramTypes - the types of parameters if available

testHasPublicMethod

public static void testHasPublicMethod(String section,
 Class<?> type,
 boolean trySuperclassFirst,
 Class<?> returnType,
 String name,
 Class<?>... paramTypes)

Parameters:

section - the section of the specification

type - the data type

trySuperclassFirst - if tht super class if available should be tested first

returnType - the expected return type

name - the name of the method

paramTypes - types of parameters

testHasPublicMethod

public static void testHasPublicMethod(String section,
 Class<?> type,
 String name,
 boolean hasParameters)

Tests if the given type has a public method with the given signature.

Parameters:

section - the section of the spec under test

type - the type to be checked.

name - the method name

hasParameters - the method has parameters.

Throws:

TCKValidationException - if test fails.

testHasPublicMethod

public static void testHasPublicMethod(String section,
 Class<?> type,
 String name)

Parameters:

section - the section of the specification

type - the data type

name - the name of the method

testHasNotPublicMethod

public static void testHasNotPublicMethod(String section,
 Class<?> type,
 Class<?> returnType,
 String name,
 Class<?>... paramTypes)

Tests if the given type has not a public method with the given signature.

Parameters:

section - the section of the spec under test

type - the type to be checked.

returnType - the method return type.

name - the method name

paramTypes - the parameter types.

Throws:

TCKValidationException - if test fails.

assertValue

public static void assertValue(String section,
 Object value,
 String methodName,
 Object instance)
                        throws NoSuchMethodException,
SecurityException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Checks the returned value, when calling a given method.

Parameters:

section - the section of the spec under test

value - the expected value

methodName - the target method name

instance - the instance to call

Throws:

NoSuchMethodException - if no method with the given name exists.

SecurityException - if a security problem occurs.

IllegalAccessException - if the method may not be called, e.g. due to security constraints.

IllegalArgumentException - if a wrong or inappropriate argument was provided.

InvocationTargetException - if an exception thrown by an invoked method or constructor.

TCKValidationException - if test fails.

testImmutable

public static void testImmutable(String section,
 Class<?> type)

Deprecated.

This was never used by the TCK, as immutability is highly recommended, but not enforced. MutabilityDetector is also incompatible with the Java Platform Module System and not actively developed in recent years.

Tests the given class being immutable.

Parameters:

section - the section of the spec under test

type - the type to be checked.

Throws:

TCKValidationException - if test fails.

testImmutableOpt

public static boolean testImmutableOpt(String section,
 Class type)

Deprecated.

This was never used by the TCK, as immutability is highly recommended, but not enforced. MutabilityDetector is also incompatible with the Java Platform Module System and not actively developed in recent years.

Test for immutability (optional recommendation), writes a warning if not given.

Parameters:

section - the section of the spec under test

type - the type to be checked.

Returns:

true, if the instance is probably immutable.