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

## @JavaBean Tag Reference

Tags for declaration of JavaBean BeanInfo classes

Applies to: JavaBeans

### @JavaBean Class Level Tags

@javabean.attribute
@javabean.class
@javabean.icons

### @JavaBean Method Level Tags

@javabean.method
@javabean.param
@javabean.property

### @JavaBean Field Level Tags

## @JavaBean Class Level Tag Usage

### @javabean.attribute (0..*)

Defines the attributes of the JavaBean (propertyorder, etc).

Applies to: JavaBeans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Name of the attribute | true
value | text |  | Value of the attribute | true
rtexpr | bool |  | Is the value a Java expression? Valid options are: true false Default value(s): false | false

### @javabean.class (0..1)

Used to specify class related information of JavaBean BeanInfo

Applies to: JavaBeans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Name of the JavaBean (typically the unqualified className) | true
class | text |  | Class name of real bean | false
displayName | text |  | The name displayed for the JavaBean | false
shortDescription | text |  | A short description about the JavaBean | false
defaultProperty | text |  | The default property of the JavaBean | false
expert | bool |  | Is the JavaBean used in expert mode ? Valid options are: true false Default value(s): false | false
hidden | bool |  | Is the JavaBean hidden ? Valid options are: true false Default value(s): false | false
preferred | bool |  | Is the JavaBean preferred ? Valid options are: true false Default value(s): false | false
customizer | text |  | Fully qualified class name of the JavaBean customizer | false
stopClass | text |  | Fully qualified class name of the JavaBean ancestor used to stop introspection for additionnal informations | false

### @javabean.icons (0..1)

Defines the icons used for the visual aspect of the JavaBean.

Applies to: JavaBeans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
mono16 | text |  | Absolute or relative resource name for the monochrome icon of 16x16 pixels | false
color16 | text |  | Absolute or relative resource name for the color icon of 16x16 pixels | false
mono32 | text |  | Absolute or relative resource name for the monochrome icon of 32x32 pixels | false
color32 | text |  | Absolute or relative resource name for the color icon of 32x32 pixels | false

## @JavaBean Method Level Tag Usage

### @javabean.method (0..*)

Defines the JavaBean method found by introspection

Applies to: JavaBeans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Name of the method | true
displayName | text |  | The name displayed for the method | false
shortDescription | text |  | A short description about the method | false
expert | bool |  | Is the method used in expert mode ? Valid options are: true false Default value(s): false | false
hidden | bool |  | Is the method hidden ? Valid options are: true false Default value(s): false | false
preferred | bool |  | Is the method preferred ? Valid options are: true false Default value(s): false | false

### @javabean.param (0..*)

Defines for each JavaBean method its parameters

Applies to: JavaBeans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Name of the parameter | true
displayName | text |  | The name displayed for the parameter | false
shortDescription | text |  | A short description about the parameter | false
propertyEditor | text |  | Fully qualified class name of the PropertyEditor used to edit the parameter | false

### @javabean.property (0..1)

Defines the JavaBean property found by introspection

Applies to: getter method of java bean

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
displayName | text |  | The name displayed for the property | false
shortDescription | text |  | A short description about the property | false
expert | bool |  | Is the property used in expert mode ? Valid options are: true false Default value(s): false | false
hidden | bool |  | Is the property hidden ? Valid options are: true false Default value(s): false | false
preferred | bool |  | Is the property preferred ? Valid options are: true false Default value(s): false | false
bound | bool |  | Is the property bound ? Valid options are: true false Default value(s): false | false
constrained | bool |  | Is the property constrained ? Valid options are: true false Default value(s): false | false
propertyEditor | text |  | Fully qualified class name of the PropertyEditor used to edit the property | false
readOnly | bool |  | Is the JavaBean property read-only ? Valid options are: true false Default value(s): false | false
getter | text |  | The name of the getter method for this property | false
setter | text |  | The name of the setter method for this property | false

## @JavaBean Field Level Tag Usage