net.trajano.commons.testing

Class UtilityClassTestUtil

java.lang.Object

net.trajano.commons.testing.UtilityClassTestUtil

public final class UtilityClassTestUtil
extends Object

This provides a test to check certain properties of a utility class. Primarily that it has only one private constructor and no non-static methods and it is final.

Author:

Archimedes Trajano

Field Summary

Fields

Modifier and Type	Field and Description
private static ResourceBundle	R Resource bundle.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UtilityClassTestUtil() Prevent instantiation of utility class.

Method Summary

Methods

Modifier and Type	Method and Description
private static void	assertUtilityClassClassWellDefined(Class<?> clazz) A utility class class is well defined if it is final and there is one and only one declared constructor.
private static void	assertUtilityClassConstructorWellDefined(Constructor<?> constructor) A utility class constructor is well defined if it is private.
private static void	assertUtilityClassMethodsWellDefined(Class<?> clazz) Methods of a utility class should be static if it was defined on the class itself.
static void	assertUtilityClassWellDefined(Class<?> clazz) Verifies that a utility class is well defined.

Methods inherited from class java.lang.Object

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

Field Detail

R

private static final ResourceBundle R

Resource bundle.

Constructor Detail

UtilityClassTestUtil

private UtilityClassTestUtil()

Prevent instantiation of utility class.

Method Detail

assertUtilityClassClassWellDefined

private static void assertUtilityClassClassWellDefined(Class<?> clazz)

A utility class class is well defined if it is final and there is one and only one declared constructor.

Parameters:

clazz - class to evaluate

assertUtilityClassConstructorWellDefined

private static void assertUtilityClassConstructorWellDefined(Constructor<?> constructor)
                                                      throws ReflectiveOperationException

A utility class constructor is well defined if it is private.

Parameters:

constructor - constructor

Throws:

ReflectiveOperationException - when there is a problem performing reflection on the class.

assertUtilityClassMethodsWellDefined

private static void assertUtilityClassMethodsWellDefined(Class<?> clazz)

Methods of a utility class should be static if it was defined on the class itself.

Parameters:

clazz - class to evaluate

assertUtilityClassWellDefined

public static void assertUtilityClassWellDefined(Class<?> clazz)
                                          throws ReflectiveOperationException

Verifies that a utility class is well defined.

Parameters:

clazz - utility class to verify.

Throws:

ReflectiveOperationException - problem accessing the class or its elements using reflection.