org.jrebirth.af.core.util

Class CheckerUtility

java.lang.Object

org.jrebirth.af.core.util.CheckerUtility

All Implemented Interfaces:

MessageContainer, UtilMessages

public final class CheckerUtility
extends Object
implements UtilMessages

The class CheckerUtility. Some Useful method utilities to check if API is respected.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private static JRLogger	LOGGER The class logger.

Fields inherited from interface org.jrebirth.af.core.util.UtilMessages

ARGUMENT_DETAIL, ARGUMENT_LIST, BAD_CANONICAL_PATH, BROKEN_API_NO_METHOD, BROKEN_API_WRONG_PARAMETERS, BROKEN_WAVE_BAD_ITEM_LIST, BROKEN_WAVE_SENT, CANT_READ_CACHED_JAR_FILE, FILE_UNREADABLE, GENERIC_TYPE_ERROR_1, GENERIC_TYPE_ERROR_2, NO_ANNOTATION_PROPERTY, NO_ANNOTATION_PROPERTY_VALUE, NO_CONSTRUCTOR, PARSE_CACHED_JAR_FILE, RESOURCE_IGNORED, USE_DEFAULT_CLASSLOADER, USE_JNLP_CLASSLOADER, WAVE_HANDLER_METHOD_REQUIRED

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CheckerUtility() Private Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private static boolean	checkMethodSignature(Method method, List<WaveItem<?>> wParams) Compare method parameters with wave parameters.
static void	checkWave(Wave wave) Check that wave has all data required by the WaveType contract (if any).
static void	checkWaveTypeContract(Class<? extends WaveReady> waveReadyClass, WaveType... waveTypes) Check if wave Type contract is respected for the the given WaveReady class.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final JRLogger LOGGER

The class logger.

Constructor Detail

CheckerUtility

private CheckerUtility()

Private Constructor.

Method Detail

checkWaveTypeContract

public static void checkWaveTypeContract(Class<? extends WaveReady> waveReadyClass,
                         WaveType... waveTypes)

Check if wave Type contract is respected for the the given WaveReady class. Throws a Runtime exception is Wave Contract is broken.

Parameters:

waveReadyClass - the WaveReady class to check

waveTypes - the contract to respect (could be several WaveType)

checkMethodSignature

private static boolean checkMethodSignature(Method method,
                           List<WaveItem<?>> wParams)

Compare method parameters with wave parameters.

Parameters:

method - the method to check

wParams - the wave parameters taht define the contract

Returns:

true if the method has the right signature

checkWave

public static void checkWave(Wave wave)

Check that wave has all data required by the WaveType contract (if any). Data can be stored into WaveData wrapper or WaveBean

Parameters:

wave - the wave to check