algoutils-tutor/org.tudalgo.algoutils.reflect/ClassTester

ClassTester

@Deprecated(since = "0.7.0", forRemoval = true)

public class ~~ClassTester~~<T>(source)

Deprecated (for removal)

Since version 0.7.0

A class tester which tests properties of a class. This class is deprecated and will be removed in a future release. Use the new API located in the org.tudalgo.algoutils.tutor.general.reflections package instead.

Author

Ruben Deisenroth

Constructors

public void ClassTester(String packageName, String className, double similarity, int accessModifier, Class<? super T> superClass, List<IdentifierMatcher> implementsInterfaces, T classInstance)

Constructs and initializes a class tester.

public void ClassTester(String packageName, String className, double similarity, int accessModifier, Class<? super T> superClass, ArrayList<IdentifierMatcher> implementsInterfaces)

Constructs and initializes a class tester.

public void ClassTester(String packageName, String className, double similarity, int accessModifier)

Constructs and initializes a class tester.

public void ClassTester(String packageName, String className, double similarity)

Constructs and initializes a class tester.

public void ClassTester(String packageName, String className)

Constructs and initializes a class tester.

public void ClassTester(Class<T> clazz)

Constructs and initializes a class tester.

Properties

public int accessModifier

The expected access modifier count.

classIdentifier

public IdentifierMatcher classIdentifier

The class identifier containing the name of the class and the similarity to accept alternative identifiers.

public T classInstance

The class instance of the tested class.

implementsInterfaces

public List<IdentifierMatcher> implementsInterfaces

The matcher used for the interfaces that are expected to be implemented.

public Launcher spoon

The spoon launcher which allows source code analysis and transformation.

public Class<? super T> superClass

The expected super class.

public Class<T> theClass

The resolved class that will be tested.

Functions

addImplementsInterface

public void addImplementsInterface(String interfaceName)

public void addImplementsInterface(IdentifierMatcher interfaceMatcher)

public void addImplementsInterface(String interfaceName, double similarity)

Adds an interface matcher used for the test class.

assertAccessModifier

public void assertAccessModifier()

Tests whether the access modifier count is correct and fails it with a predefined message if it fails.

assertclassInstanceResolved

public void assertclassInstanceResolved()

Tests whether the class instance of the tested class is not null.

assertClassNotNull

public static void assertClassNotNull(Class<? extends Object> theClass, String className)

Tests whether the class instance is not null and fails with a proper message if it is null.

assertClassResolved

public void assertClassResolved()

Tests that theClass is not null and fails with the predefined message if it cannot be resolved.

assertConstructorValid

public void assertConstructorValid(Constructor<T> constructor, int accessModifier, ArrayList<ParameterMatcher> parameters)

public void assertConstructorValid(Constructor<T> constructor, int accessModifier, Array<ParameterMatcher> parameters)

Tests whether a constructor was declared correctly.

assertDoesNotImplementAnyInterfaces

public void assertDoesNotImplementAnyInterfaces()

Tests whether there are no interface extension.

assertEnumConstants

public void assertEnumConstants(Array<String> expectedConstants)

Tests whether the enum constants with the specified names exists.

assertFieldEquals

public void assertFieldEquals(Field field, Object expected)

Tests whether a field has a certain content.

public void assertFieldEquals(Field field, Object expected, String additionalMessage)

Tests whether the specified field has a specified content.

assertHasGetter

public void assertHasGetter(Field attribute, Array<ParameterMatcher> parameters)

Tests whether the specified field has a Getter-Method.

assertHasSetter

public void assertHasSetter(Field attribute)

public void assertHasSetter(Field attribute, Object testValue)

Tests whether the specified field has a Setter-Method.

assertImplementsInterfaces

public void assertImplementsInterfaces()

public void assertImplementsInterfaces(List<IdentifierMatcher> implementsInterfaces)

Tests whether all described interfaces by the specified matchers are being extended.

public void assertIsEnum()

Tests whether the test class is an enum.

public static void assertIsEnum(Class<? extends Object> theClass, String className)

Tests whether the class instance is an enum.

assertIsInterface

public void assertIsInterface()

Tests whether the test class is an interface.

public static void assertIsInterface(Class<? extends Object> theClass, String className)

Tests whether the class instance is an interface.

assertIsPlainClass

public void assertIsPlainClass()

Tests whether the test class is a plain class.

public static void assertIsPlainClass(Class<? extends Object> theClass, String className)

Tests whether the class instance is a plain class.

public ClassTester<T> assertSpied()

Tests whether this class is a spy.

assertSuperclass

public void assertSuperclass()

Tests whether the super classes fo the test classes matches the specified super classes.

assureClassResolved

public ClassTester<T> assureClassResolved()

Resolves the class if necessary.

public ClassTester<T> assureSpied()

Makes the class a spy if not done already.

assureSpoonLauncherModelsBuild

public ClassTester<T> assureSpoonLauncherModelsBuild()

Returns instance of a class tester with the needed configuration for spoon.

public boolean class_resolved()

Returns true if theClass is not null.

classInstanceResolved

public boolean classInstanceResolved()

Returns true if the class instance of the tested class is not null.

public Class<T> findClass()

Resolves a class with the current class name and similarity.

public Class<T> findClass(double similarity)

Resolves a class with the specified similarity.

public Class<T> findClass(String packageName, String className, double similarity)

Resolves a class with the specified name and similarity.

public static T findInstance<T>(Class<? super T> clazz, String className)

Resolves an instance of a given class (even abstract).

generateDerivedClass

public static Class<? extends T> generateDerivedClass<T>(Class<T> clazz, String className, String derivedClassName)

Generates a derived class from a specified class.

getAccessModifier

public int getAccessModifier()

Returns the expected access modifier.

public List<Field> getAllFields()

Returns all fields of the test class and its super classes.

public static List<Field> getAllFields(Class<? extends Object> clazz)

Returns all fields of a class and its super classes recursively.

getClassIdentifier

public IdentifierMatcher getClassIdentifier()

Returns the class matcher used on the test class.

getClassInstance

public T getClassInstance()

Returns class instance of the tested class.

getClassNotFoundMessage

public String getClassNotFoundMessage()

public static String getClassNotFoundMessage(String className)

Generates a predefined class not found message.

getDefaultValue

public static Object getDefaultValue(Class<? extends Object> type)

Returns the default value for the specified type.

getEnumConstantMissingMessage

public static String getEnumConstantMissingMessage(String constantName)

Generates a predefined message for a missing enum constant.

public Enum<? extends Object> getEnumValue(String expectedName, double similarity)

Returns a specific enum value.

public static Enum<? extends Object> getEnumValue<T>(Class<Enum<? extends Object>> enumClass, String expectedName, double similarity)

Returns the specified enum value.

public Object getFieldValue(Field field)

Returns the field content.

public static Object getFieldValue(Object instance, Field field)

Returns the content of a field.

getImplementsInterfaces

public List<IdentifierMatcher> getImplementsInterfaces()

Returns the implemented interfaces of the tested class.

getInterfaceNotImplementedMessage

public static String getInterfaceNotImplementedMessage(String interfaceName)

Generates a predefined interface not found message.

getMockingDetails

public MockingDetails getMockingDetails()

Returns the MockingDetails of theClass.

public T getNewInstance()

Returns a new test class instance.

getNewRealInstance

public T getNewRealInstance()

Returns a new test class instance.

getRandomEnumConstant

public Enum<? extends Object> getRandomEnumConstant()

Returns a random enum constant.

public static Enum<? extends Object> getRandomEnumConstant(Class<Enum<? extends Object>> enumClass, String enumClassName)

Returns a random enum constant from the available enum constants.

public static Object getRandomValue(Class<? extends Object> type)

Returns a random value for the specified type.

public Launcher getSpoon()

Returns the spoon launcher which allows source code analysis and transformation.

public Class<? super T> getSuperClass()

Returns the super class of the tested class.

public Class<T> getTheClass()

Returns the test classes if it is already resolved.

public boolean is_mock()

Returns true if theClass is mocked.

public boolean is_spy()

Returns true if theClass is a spy.

legacyFindInstance

public static T legacyFindInstance<T>(Class<? super T> clazz, String className)

Resolves an instance of a given class (even abstract).

public ClassTester<T> resolve()

Resolves the class and instance and stores them.

resolveAttribute

public Field resolveAttribute(AttributeMatcher matcher)

Resolves a field (attribute) with a specified matcher.

public ClassTester<T> resolveClass()

Finds the class to test and stores it.

resolveConstructor

public Constructor<T> resolveConstructor(List<ParameterMatcher> parameters)

Resolves a constructor with the specified parameters.

public Constructor<T> resolveConstructor(Array<ParameterMatcher> parameters)

Resolves a constructor with the parameters.

resolveInstance

public T resolveInstance()

Resolves a test class instance.

public ClassTester<T> resolveReal()

Resolves the class and instance and stores them.

resolveRealInstance

public ClassTester<T> resolveRealInstance()

Resolve a real test class instance.

setAccessModifier

public void setAccessModifier(int accessModifier)

Sets the expected access modifier the specified value.

setClassIdentifier

public void setClassIdentifier(IdentifierMatcher classIdentifier)

Sets the class matcher used on the test class to the new value.

setClassInstance

public void setClassInstance(T classInstance)

Sets class instance of the tested class to the specified value.

public void setField(Field field, Object value)

Sets a field value to the specified value.

public static void setField(Object instance, Field field, Object value)

Sets the field to the specified value.

public Object setFieldRandom(Field field)

Sets a field value to a random value.

public static void setFieldTyped(Field field, Object obj, Object value)

Sets the typed field to the specified value.

setImplementsInterfaces

public void setImplementsInterfaces(List<IdentifierMatcher> implementsInterfaces)

Sets the implemented class of the tested class to the specified value.

public void setSpoon(Launcher spoon)

Sets the spoon launcher which allows source code analysis and transformation to the specified value.

public void setSuperClass(Class<? super T> superClass)

Sets the super class of the tested class to the specified value.

public void setTheClass(Class<T> theClass)

Sets the test class instance to the specified class instance.

public ClassTester<T> verify()

public ClassTester<T> verify(double minSimilarity)

Tests whether the Class is declared correctly.