XDoclet: Attribute-Oriented Programming - Tag Reference

##### XDoclet

- Overview
- News and Status
- Download/Installation
- Using XDoclet
- Best Practices
- FAQ
- License

##### Ant Task Reference

- <doclet .. />
- <ejbdoclet .. />
- <hibernatedoclet .. />
- <jdodoclet .. />
- <jmxdoclet .. />
- <mockdoclet .. />
- <portletdoclet .. />
- <springdoclet .. />
- <tapestrydoclet .. />
- <webdoclet .. />
- <wseedoclet .. />

##### Tag Reference

- apache (@soap @struts @axis @tapestry)
- bea (@weblogic)
- borland (@bes)
- caucho (@resin)
- ejb (@ejb @dao)
- exolab (@castor)
- hp (@hpas)
- hibernate (@hibernate)
- ibm (@websphere)
- java (@javabean)
- jboss (@jboss)
- jdo (@jdo)
- jmx (@jmx)
- jsf (@jsf)
- macromedia (@jrun)
- mockobjects (@mock)
- mvcsoft (@mvcsoft)
- mx4j (@mx4j)
- objectweb (@jonas)
- oracle (@oc4j)
- orion (@orion)
- portlet (@portlet)
- pramati (@pramati)
- spring (@spring)
- sun (@sunone)
- sybase (@easerver)
- tjdo (@tjdo)
- web (@web @jsp)
- webwork (@webwork)
- wsee (@wsee)
- xdoclet (@xdoclet @doc @msg)

##### Feature Documentation

- Using Value Objects
- EJB Environment Handling

##### Advanced

- Maven Plug-in
- Merge Points
- IDE Integration
- Migration from EJBDoclet
- Ant 1.5 Troubleshooting

##### Community

- Feedback
- Resources
- Tools

##### Development

- Developer Guide
- Javadoc (API)
- Template Language (*.xdt)
- XJavaDoc Site

##### Search XDoclet

##### Project Documentation

- About XDoclet
- Project Info
- Project Reports
- Development Process

## @spring Tag Reference

Tags for generating a bean-wiring file for the Spring framework.

### @spring Class Level Tags

@spring.bean
@spring.property

### @spring Method Level Tags

@spring.constructor-arg
@spring.property
@spring.validator
@spring.validator-args
@spring.validator-var

### @spring Field Level Tags

## @spring Class Level Tag Usage

### @spring.bean (0..1)

Defines a Spring bean.

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
id | text |  | ID for the bean. This should be unique within the spring configuration. Either this property, or the "name" property must be specified for each bean. | false
name | text |  | Name for the bean. This property can be used in place of the "id" attribute, where the name being used contains characters that would be invalid as an XML ID attribute. | false
autowire | text |  | Set's the autowiring mode for the bean. "byName" wires beans to properties by matching the bean's name to the property name. "byType" wires beans to properties by matching a bean's type to the property type. "constructor" wires beans through a constructor's parameters by matching types. "auto-detect" allows Spring to choose between "byType" and "constructor" as it sees fit. "no" indicates that no auto-wiring should be performed on this bean. Valid options are: no byName byType constructor auto-detect | false
dependency-check | text |  | Sets dependency checking rules on a bean. "none" indicates no dependency checking. "simple" dependency checking includes primitives and String. "objects" dependency checking includes collaborators (other beans). "all" performs both "simple" and "objects" dependency checking. Valid options are: none objects simple all | false
description | text |  | Describes the bean. | false
destroy-method | text |  | The name of an method to be invoked on bean factory shutdown. | false
init-method | text |  | The name of an initialization method to be invoked upon bean instantiation. | false
lazy-init | bool |  | If "true", Spring will instantiate this bean when it's needed, rather than at bean factory startup. | false
singleton | bool |  | If "true", one shared instance of this bean will be returned with every call to getBean(). If "false" each call results in a new instance. Default value(s): true | false

### @spring.property (0..*)

Defines a property which may be defined in a superclass, but not in this particular bean class.

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
ref | text |  | The id of another bean to wire to the property. | false
list | text |  | Comma-separated list of values to assign as a List to a property of type java.util.List. | false
name | text |  | The name of the property to be wired. | true
value | text |  | The value to assign to the property. | false

## @spring Method Level Tag Usage

### @spring.constructor-arg (0..*)

Wires a bean constructor argument.

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
ref | text |  | The id of another bean to wire to the constructor argument. | false
list | text |  | Comma-separated list of values to assign as a List to a constructor argument of type java.util.List. | false
value | text |  | The value to assign to the constructor argument. | false

### @spring.property (0..*)

Declares a bean property.

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
ref | text |  | The id of another bean to wire to the property. | false
list | text |  | Comma-separated list of values to assign as a List to a property of type java.util.List. | false
value | text |  | The value to assign to the property. | false

### @spring.validator (0..*)

Defines Commons Validator for current setter field.

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
type | text |  | Validator type, such as "required" | true
msgkey | text |  | Override key for the validator error message | false
msgvalue | text |  | Explicitly define a validator error message | false
page | text |  | Only fields with a "page" attribute value that is equal to or less than the page property on the form JavaBean are processed. | false
arg0value | text |  | Value of argument index 0 | false
arg0resource | text |  | Resource key of argument index 0 | false
arg1value | text |  | Value of argument index 1 | false
arg1resource | text |  | Resource key of argument index 1 | false
arg2value | text |  | Value of argument index 2 | false
arg2resource | text |  | Resource key of argument index 2 | false
arg3value | text |  | Value of argument index 3 | false
arg3resource | text |  | Resource key of argument index 3 | false

### @spring.validator-args (0..1)

Defines arguments for current setter field.

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
arg0value | text |  | Value of argument index 0 | false
arg0resource | text |  | Resource key of argument index 0 Default value(s): FormName.fieldName | false
arg1value | text |  | Value of argument index 1 | false
arg1resource | text |  | Resource key of argument index 1 | false
arg2value | text |  | Value of argument index 2 | false
arg2resource | text |  | Resource key of argument index 2 | false
arg3value | text |  | Value of argument index 3 | false
arg3resource | text |  | Resource key of argument index 3 | false

### @spring.validator-var (0..*)

Defines Commons Validator variable

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Variable name | true
value | text |  | Variable value | true

## @spring Field Level Tag Usage