In many places, applications can use use Java 5 annotations as an alternative to XML and Java properties configuration. This page serves as a reference for all annotations across the framework.
Action Annotations
| Note |
|---|
Since 2.1, these annotations are provided by the Convention Plugin. Codebehind and Zero Config plugins are deprecated from 2.1 on. |
Action annotations are available when the framework scans the classpath for Action classes, rather than specifying individual mappings through XML configuration. See the Zero Configuration Convention Plugin page for information on how to set up classpath scanning to allow the use of Action annotations.
Annotation | Description |
|---|---|
Group of @Action annotations, maps multiple URLs to the same action | |
Defines the URL of an action | |
Gropup of @InterceptorRef annotations | |
Interceptor, or interceptor stack to be applied to at action | |
Group of @Result annotations | |
Defines a result for an action | |
Set the path of the action URL (used to overwrite the default) | |
Set where the results are located (used to overwrite the default) | |
Set the parent package of the actions (used to overwrite the default) | |
Group of @ExceptionMapping annotations | |
Defines an exception mapping |
Workflow Annotations
Annotation | Description |
|---|---|
Defines what method to execute, or result to be returned if there are validation errors | |
Overrides the namespace of an action | |
Defines an existing configuration package for the action's package to extend | |
Defines an action Result | |
Defines multiple Results |
Interceptor Annotations
To use these annotations, you have to specify the AnnotationWorkflowInterceptor to your interceptor stack.
...
Annotation | Description | |
|---|---|---|
Checks if there are any conversion errors for a field. | ||
Checks that a date field has a value within a specified range. | ||
Checks that a double field has a value within a specified range. | ||
Checks that a field is a valid e-mail address. | ||
Validates an expression. | ||
Uses an OGNL expression to perform its validator. | ||
Checks that a numeric field has a value within a specified range. | ||
Validates a regular expression for a field. | ||
Checks that a field is non-null. | ||
Checks that a String field is not empty. | ||
Checks that a String field is of the right length. StringRegexValidator Annotation | ||
Invokes a regular expression to validate a String field. | Checks that a field is a valid URL. | |
Marker annotation for validation at Type level. | ||
Used to group validation annotations. | ||
Invokes the validation for a property's object type. | ||
Use this annotation for your custom validator types. |
...
In short, instead of specifying the types found in collections and maps as documented in Type Conversion, the collection's generic type is used. By using annotations, an application should be able to avoid using any ClassName-conversion.properties files.
...
Annotation | Description |
|---|---|
Marker annotation for type conversions at Type level. | |
For Collection and Map types: Create the types within the Collection or Map, if null. | |
For Generic types: Specify the element type for Collection types and Map values. | |
For Generic types: Specify the key type for Map keys. | |
For Generic types: Specify the key property name value. | |
Used for class and application wide conversion rules. |
Tiles Annotations
The Tiles Plugin provides it's own set of Annotations. They can be used to keep tiles.xml short. Instead tiles definitions can be created by annotating actions.
| Annotation | Description |
|---|---|
| TilesDefinition | Represents a <definition> element in tiles.xml |
| TilesDefinitions | A list of TilesDefinition Annotations |
TilesPutAttribute | Represents a <put-attribute> element in tiles.xml |
| TilesPutListAttribute | Represents a <put-list-attribute> element in tiles.xml |
| TilesAddAttribute | Represents a <add-attribute> element in tiles.xml |
| TilesAddListAttribute | Represents a <add-list-attribute> element in tiles.xml |