org.jasig.portal.tools.checks
Class ClassPresenceCheck

java.lang.Object
  org.jasig.portal.tools.checks.BaseCheck
      org.jasig.portal.tools.checks.ClassPresenceCheck

All Implemented Interfaces:

ICheck

Direct Known Subclasses:

MethodPresenceCheck

public class ClassPresenceCheck
extends BaseCheck

Checks that a class named as a constructor argument is present.

Since:

uPortal 2.5

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Field Summary

Fields inherited from class org.jasig.portal.tools.checks.BaseCheck

log

Constructor Summary

ClassPresenceCheck(String targetClass)
Each instance of ClassPresenceCheck exists to test for the presence of exactly one class.

Method Summary

protected CheckResult	doCheckInternal()
String	getRemediationAdvice()
void	setRemediationAdvice(String remediationAdvice) The advice to provide to resolve a failed check

Methods inherited from class org.jasig.portal.tools.checks.BaseCheck

doCheck, getDescription, isFatal, setDescription, setFatal

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPresenceCheck

public ClassPresenceCheck(String targetClass)

Each instance of ClassPresenceCheck exists to test for the presence of exactly one class. That class must be specified as the single required constructor argument, which must be a non-null String representing the fully qualified name of the class.

Parameters:

targetClass - fully qualified name of the target class

Throws:

IllegalArgumentException - if targetClass is null

Method Detail

getRemediationAdvice

public String getRemediationAdvice()

Returns:

the remediationAdvice

setRemediationAdvice

public void setRemediationAdvice(String remediationAdvice)

The advice to provide to resolve a failed check

Parameters:

remediationAdvice - the remediationAdvice to set

doCheckInternal

protected CheckResult doCheckInternal()

Specified by:

doCheckInternal in class BaseCheck

Returns:

The check result