Annotation Interface LegacyCheck
Annotation to handle legacy validators tests in order to map them to the new ICheck-based mechanizm
This annotation is applied to the legacy validator methods.
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionCheck complexity designatorCheck identifier.Check title.String[]
The array of contained object class names used in validation method.boolean
Defines the default enablement status for the check.Defines the value indicating whether the check will include top object.Issue severityIssue typeThe top object class name.
-
Element Details
-
checkId
String checkIdCheck identifier. If not provided then the generated one (based on validation method name and id prefix from validator class annotation) will be used. It's recommended to keep it empty (default)- Returns:
- the check ID, cannot be
null
, can be empty
- Default:
- ""
-
checkTitle
String checkTitleCheck title. If not provided then the generated one (based on validation method and validator class names) will be used. It's recommended to keep it empty (default)- Returns:
- the check title, cannot be
null
, can be empty
- Default:
- ""
-
topObject
String topObjectThe top object class name. Defines the top object class name to be used in validation. Overrides the value in class annotationLegacyChecks
if any.- Returns:
- the top object class name, cannot be
null
, can be empty
- Default:
- ""
-
contained
String[] containedThe array of contained object class names used in validation method. By default the class name will be taken from validation method parameter type, but the particular test method may require additional types.- Returns:
- the array of contained object class names, cannot be
null
, can be empty
- Default:
- {}
-
checkComplexity
ValidationComplexity checkComplexityCheck complexity designator- Returns:
- check complexity value, cannot be
null
- Default:
- NORMAL
-
issueSeverity
ValidationSeverity issueSeverityIssue severity- Returns:
- check issue severity value, cannot be
null
- Default:
- MINOR
-
issueType
ValidationIssueType issueTypeIssue type- Returns:
- check issue type value, cannot be
null
- Default:
- WARNING
-
includeTop
IncludeTop includeTopDefines the value indicating whether the check will include top object. Overrides the class annotationLegacyChecks
value- Returns:
- include top value, cannot be
null
- Default:
- DEFAULT
-
enabled
boolean enabledDefines the default enablement status for the check. In case if the check is expensive/situational, the developer could state that it should be enabled manually by the client to be able to perform. By default all checks are enabled- Parameters:
enabled
- True if the check is enabled by default, false otherwise
- Default:
- true
-