org.perfidix.element

Class BenchmarkMethod

java.lang.Object

org.perfidix.element.BenchmarkMethod

public final class BenchmarkMethod
extends Object

Class to mark one method which are possible benchmarkable. The method hold helping methods and additional functionality for benchmarkable methods like returning possible BeforeBenchClass, BeforeFirstRun, BeforeEachRun, AfterEachRun, AfterLastRun and AfterBenchClass annotated related methods.

Author:

Sebastian Graf, University of Konstanz

See Also:

AfterBenchClass, AfterLastRun, AfterEachRun, BeforeEachRun, BeforeFirstRun, BeforeBenchClass

Constructor Summary

Constructors

Constructor and Description
BenchmarkMethod(Method paramMethod) Constructor, with a definite method to bench.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Method[]	findAfterEachRun() Method to find a AfterEachRun annotation.
Method[]	findAfterLastRun() Method to find a AfterLastRun annotation.
static Method	findAndCheckAnyMethodByAnnotation(Class<?> clazz, Class<? extends Annotation> anno) This class finds any method with a given annotation.
Method[]	findBeforeEachRun() Method to find a BeforeEachRun annotation.
Method[]	findBeforeFirstRun() Method to find a BeforeFirstRun annotation.
Method	getMethodToBench() Simple getter for encapsulated method.
String	getMethodWithClassName() This method returns the fully qualified name consisting of its own name and its class name
static int	getNumberOfAnnotatedRuns(Method meth) Getting the number of runs corresponding to a given method.
int	hashCode()
static boolean	isBenchmarkable(Method meth) This method should act as a check to guarantee that only specific Benchmarkables are used for benching.
static boolean	isReflectedExecutable(Method meth, Class<? extends Annotation> anno) Checks if this method is executable via reflection for perfidix purposes.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BenchmarkMethod

public BenchmarkMethod(Method paramMethod)

Constructor, with a definite method to bench. The method has to be checked with isBenchmarkable(Method) first, otherwise an IllegalArgumentException could arise.

Parameters:

paramMethod - method to be benched (eventually)

Method Detail

findBeforeFirstRun

public Method[] findBeforeFirstRun()
                            throws PerfidixMethodCheckException

Method to find a BeforeFirstRun annotation. This method should be invoked for all methods. The corresponding class is searched after suitable methods and checks for integrity are made. If there are multiple BeforeFirstRun -annotated methods available, an exception is thrown. If there are designated special BeforeFirstRun methods as given in the parameter of the Bench-annotation, this method is taken with any further checking of the other methods in the class.

Returns:

Annotated method with BeforeFirstRun annotation, null of none exists

Throws:

PerfidixMethodCheckException - if integrity check of class and method fails.

See Also:

BeforeFirstRun, Bench

findBeforeEachRun

public Method[] findBeforeEachRun()
                           throws PerfidixMethodCheckException

Method to find a BeforeEachRun annotation. This method should be invoked for all methods. The corresponding class is searched after suitable methods and checks for integrity are made. If there are multiple BeforeEachRun -annotated methods available, an exception is thrown. If there are designated special BeforeEachRun methods as given in the parameter of the Bench-annotation, this method is taken with any further checking of the other methods in the class.

Returns:

Annotated method with BeforeEachRun annotation, null of none exists

Throws:

PerfidixMethodCheckException - if integrity check of class and method fails.

See Also:

BeforeEachRun, Bench

findAfterEachRun

public Method[] findAfterEachRun()
                          throws PerfidixMethodCheckException

Method to find a AfterEachRun annotation. This method should be invoked for all methods. The corresponding class is searched after suitable methods and checks for integrity are made. If there are multiple AfterEachRun -annotated methods available, an exception is thrown. If there are designated special AfterEachRun methods as given in the parameter of the Bench-annotation, this method is taken with any further checking of the other methods in the class.

Returns:

Annotated method with AfterEachRun annotation, null of none exists

Throws:

PerfidixMethodCheckException - if integrity check of class and method fails.

See Also:

AfterEachRun, Bench

findAfterLastRun

public Method[] findAfterLastRun()
                          throws PerfidixMethodCheckException

Method to find a AfterLastRun annotation. This method should be invoked for all methods. The corresponding class is searched after suitable methods and checks for integrity are made. If there are multiple AfterLastRun -annotated methods available, an exception is thrown. If there are designated special AfterLastRun methods as given in the parameter of the Bench-annotation, this method is taken with any further checking of the other methods in the class.

Returns:

Annotated method with AfterLastRun annotation, null of none exists

Throws:

PerfidixMethodCheckException - if integrity check of class and method fails.

See Also:

AfterLastRun, Bench

getMethodToBench

public Method getMethodToBench()

Simple getter for encapsulated method.

Returns:

the methodToBench

getNumberOfAnnotatedRuns

public static int getNumberOfAnnotatedRuns(Method meth)

Getting the number of runs corresponding to a given method. The method MUST be a benchmarkable method, otherwise an IllegalStateException exception arises. The number of runs of an annotated method is more powerful than the number of runs as denoted by the benchclass annotation.

Parameters:

meth - to be checked

Returns:

the number of runs of this benchmarkable-method

findAndCheckAnyMethodByAnnotation

public static Method findAndCheckAnyMethodByAnnotation(Class<?> clazz,
                                       Class<? extends Annotation> anno)
                                                throws PerfidixMethodCheckException

This class finds any method with a given annotation. The method is allowed to occure only once in the class and should match the requirements for Perfidix for an execution by reflection.

Parameters:

anno - of the method to be found

clazz - class to be searched

Returns:

a method annotated by the annotation given. The method occurs only once in the class and matched the requirements of perfidix-reflective-invocation.

Throws:

PerfidixMethodCheckException - if these integrity checks fail

isBenchmarkable

public static boolean isBenchmarkable(Method meth)

This method should act as a check to guarantee that only specific Benchmarkables are used for benching.

Parameters:

meth - method to be checked.

Returns:

true if an instance of this interface is benchmarkable, false otherwise.

isReflectedExecutable

public static boolean isReflectedExecutable(Method meth,
                            Class<? extends Annotation> anno)

Checks if this method is executable via reflection for perfidix purposes. That means that the method has no parameters, no return-value, is non-static, is public and throws no exceptions.

Parameters:

meth - method to be checked

anno - anno for method to be check, necessary since different attributes are possible depending on the anno

Returns:

true if method matches requirements.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getMethodWithClassName

public String getMethodWithClassName()

This method returns the fully qualified name consisting of its own name and its class name

Returns:

the String name von the bench method consisting of fully qualified name of its class and its own name