es.ulpgc.junit4vpl.runner

Class InterfaceChecker

java.lang.Object

es.ulpgc.junit4vpl.runner.InterfaceChecker

public class InterfaceChecker
extends java.lang.Object

Provides us with an interface comparison between two classes

Constructor Summary

Constructors

Constructor and Description
InterfaceChecker(java.lang.Class<?> ModelClass, java.lang.Class<?> ClassToCheck, InterfaceCheckerI18n lang) Initialization of methods, constructors, fields of each class, and the language of the results

Method Summary

Modifier and Type	Method and Description
java.lang.String	compareClass() Let new private elements but not public ones
java.lang.String	compareClass(boolean publicAllowed) Chooses permission on private elements but extra public ones are not allowed
java.lang.String	compareClass(boolean publicAllowed, boolean noPublicRestricted) Compares both classes
boolean	compareFields(java.lang.reflect.Field fModel, java.lang.reflect.Field fTesting) Compares two fields
es.ulpgc.junit4vpl.runner.InterfaceChecker.similarity	compareMethods(java.lang.reflect.Method mModel, java.lang.reflect.Method mTesting) Compares two methods
java.lang.String	formatFieldName(java.lang.reflect.Field field) Returns a String with the name of a field
java.lang.String	formatMethodName(java.lang.reflect.Constructor<?> constructor, java.lang.String testingName) Returns the name of a constructor using the testing class name
java.lang.String	formatMethodName(java.lang.reflect.Method method, java.lang.String testingName) Returns a String giving an appropriate format to a method name
java.lang.String	hideDefaultPackage(java.lang.String className) Hides "java.lang." from a full class name
static int	LevDistance(java.lang.String a, java.lang.String b) Calculates the Levenshtein's distance between two strings
java.lang.String	mustExtends(java.lang.String superClassName, boolean inheritRestriction) Checks if it extends the class given and return the differences
java.lang.String	mustImplements(java.lang.String... iModels) Checks if the given interfaces are implemented and return the differences
java.lang.reflect.Constructor<?>	similarConstructorName(java.lang.String name, java.lang.reflect.Constructor<?> constructors) Compares a name with a list of constructors
java.lang.reflect.Field	similarFieldName(java.lang.String name, java.util.List<java.lang.reflect.Field> fields) Compares a name with a list of fields
java.lang.reflect.Method	similarMethodName(java.lang.String name, java.lang.reflect.Method method) Compares a name with a list of methods

Methods inherited from class java.lang.Object

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

Constructor Detail

InterfaceChecker

public InterfaceChecker(java.lang.Class<?> ModelClass,
                        java.lang.Class<?> ClassToCheck,
                        InterfaceCheckerI18n lang)

Initialization of methods, constructors, fields of each class, and the language of the results

Parameters:

ModelClass - - Class used as a model

ClassToCheck - - Class to be compared

lang - - Language of the result messages

Method Detail

compareClass

public java.lang.String compareClass(boolean publicAllowed,
                                     boolean noPublicRestricted)

Compares both classes

Parameters:

publicAllowed - - If this parameter is set true, you allow the ClassToCheck to have extra public elements

noPublicRestricted - - If this parameter is set true, you don't allow the ClassToCheck to have extra no public elements

Returns:

- Returns a string with all the differences between both classes

compareClass

public java.lang.String compareClass()

Let new private elements but not public ones

Returns:

Returns a string with all the differences between both classes

compareClass

public java.lang.String compareClass(boolean publicAllowed)

Chooses permission on private elements but extra public ones are not allowed

Parameters:

publicAllowed - If this parameter is set true, you allow the ClassToCheck to have extra public elements

Returns:

Returns a string with all the differences between both classes

mustImplements

public java.lang.String mustImplements(java.lang.String... iModels)

Checks if the given interfaces are implemented and return the differences

Parameters:

iModels - Name of the interfaces to implement

Returns:

String Report of the check

mustExtends

public java.lang.String mustExtends(java.lang.String superClassName,
                                    boolean inheritRestriction)

Checks if it extends the class given and return the differences

Parameters:

superClassName - Name of the superclass you want to compare with

inheritRestriction - Decides whether the superclass have to be the same as in the model (true) or can be a subclass of it (false)

Returns:

String Report of the check

compareFields

public boolean compareFields(java.lang.reflect.Field fModel,
                             java.lang.reflect.Field fTesting)

Compares two fields

Parameters:

fModel - Model field

fTesting - Testing field

Returns:

True if equal, false if different

compareMethods

public es.ulpgc.junit4vpl.runner.InterfaceChecker.similarity compareMethods(java.lang.reflect.Method mModel,
                                                                            java.lang.reflect.Method mTesting)

Compares two methods

Parameters:

mModel - Model method

mTesting - Testing method

Returns:

Similarity between both methods

LevDistance

public static int LevDistance(java.lang.String a,
                              java.lang.String b)

Calculates the Levenshtein's distance between two strings

Parameters:

a - One of the String to compare

b - The other String to compare

Returns:

The distance

similarFieldName

public java.lang.reflect.Field similarFieldName(java.lang.String name,
                                                java.util.List<java.lang.reflect.Field> fields)

Compares a name with a list of fields

Parameters:

name - Name of to filed to search for

fields - The list of fields where to look

Returns:

The most similar field found, or null if no similar field is found

similarConstructorName

public java.lang.reflect.Constructor<?> similarConstructorName(java.lang.String name,
                                                               java.lang.reflect.Constructor<?> constructors)

Compares a name with a list of constructors

Parameters:

name - Name of to constructor to search for

constructors - The list of constructors where to look

Returns:

The most similar constructor found, or null if no similar field is found

similarMethodName

public java.lang.reflect.Method similarMethodName(java.lang.String name,
                                                  java.lang.reflect.Method method)

Compares a name with a list of methods

Parameters:

name - Name of to method to search for

method - The list of methods where to look

Returns:

The most similar method found, or null if no similar field is found

hideDefaultPackage

public java.lang.String hideDefaultPackage(java.lang.String className)

Hides "java.lang." from a full class name

Parameters:

className - The full class name

Returns:

Class name after removing java.lang. if found

formatFieldName

public java.lang.String formatFieldName(java.lang.reflect.Field field)

Returns a String with the name of a field

Parameters:

field - The field to get the name

Returns:

The field name

formatMethodName

public java.lang.String formatMethodName(java.lang.reflect.Constructor<?> constructor,
                                         java.lang.String testingName)

Returns the name of a constructor using the testing class name

Parameters:

constructor - The constructor

testingName - Used for showing the testing name, not the model one

Returns:

String

formatMethodName

public java.lang.String formatMethodName(java.lang.reflect.Method method,
                                         java.lang.String testingName)

Returns a String giving an appropriate format to a method name

Parameters:

method - The method to get the name

testingName - Used for showing the testing name, not the model one

Returns:

The method name