com.philemonworks.selfdiagnose.check
Class CheckResourceBundleKey

java.lang.Object
  com.philemonworks.selfdiagnose.DiagnosticTask
      com.philemonworks.selfdiagnose.check.CheckResourceBundleKey

All Implemented Interfaces:

Serializable

public class CheckResourceBundleKey
extends DiagnosticTask

CheckResourceBundleKey is a DiagnosticTask that verifies the existence of a given key for a given resource

<checkresourcebundlekey name="some.properties" key="welcom" />
 

Author:

E.M.Micklei

See Also:

Serialized Form

Field Summary

Fields inherited from class com.philemonworks.selfdiagnose.DiagnosticTask

comment, PARAMETER_COMMENT, PARAMETER_REPORT, PARAMETER_VARIABLE, reportResults, requestor, variableName

Constructor Summary

CheckResourceBundleKey()

Method Summary

String	getDescription()
String	getKey()
String	getTaskName() On default, the task is the unqualified name for the class in lowercase.
void	initializeFromAttributes(Attributes attributes) This method is sent from the SelfDiagnoseHandler when a configuration is being processed.
void	run(ExecutionContext ctx, DiagnosticTaskResult result) Run the task.
void	setKey(String key)
void	setName(String name)
void	setUp(ExecutionContext ctx) Override this method to verify that task parameters are initialized/set correctly.

Methods inherited from class com.philemonworks.selfdiagnose.DiagnosticTask

createResult, getComment, getDefaultReportTemplate, getRequestor, getVariableName, hasComment, isReportResults, run, run, setComment, setReportResults, setRequestor, setVariableName

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckResourceBundleKey

public CheckResourceBundleKey()

Method Detail

initializeFromAttributes

public void initializeFromAttributes(Attributes attributes)

Description copied from class: DiagnosticTask

This method is sent from the SelfDiagnoseHandler when a configuration is being processed. Use the passed attributes to initialize the receiver. If a variable parameter is passed then store it.

Overrides:

initializeFromAttributes in class DiagnosticTask

Parameters:

attributes - org.xml.sax.Attributes

getDescription

public String getDescription()

Specified by:

getDescription in class DiagnosticTask

Returns:

String the description

setUp

public void setUp(ExecutionContext ctx)
           throws DiagnoseException

Description copied from class: DiagnosticTask

Override this method to verify that task parameters are initialized/set correctly.

Overrides:

setUp in class DiagnosticTask

Parameters:

ctx - ExecutionContext

Throws:

DiagnoseException

run

public void run(ExecutionContext ctx,
                DiagnosticTaskResult result)
         throws DiagnoseException

Description copied from class: DiagnosticTask

Run the task. If an error is detected then raise a DiagnoseException. Otherwise use the result object to the report any messages when a run is completed.

Specified by:

run in class DiagnosticTask

Parameters:

ctx - ExecutionContext

result - DiagnosticTaskResult

Throws:

DiagnoseException

getKey

public String getKey()

setKey

public void setKey(String key)

getTaskName

public String getTaskName()

Description copied from class: DiagnosticTask

On default, the task is the unqualified name for the class in lowercase. This name must be equal to that of the complexType as defined in the XSD.

Overrides:

getTaskName in class DiagnosticTask

Returns:

String the name for this task

setName

public void setName(String name)