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

## @jsf Tag Reference

Defines managed beans and navigation rules for jsf applications

### @jsf Class Level Tags

@jsf.bean
@jsf.converter
@jsf.navigation
@jsf.render-kit
@jsf.validator

### @jsf Method Level Tags

@jsf.managed-property
@jsf.validator-attribute

### @jsf Field Level Tags

## @jsf Class Level Tag Usage

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

Defines a managed bean and its attributes.

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Define a unique name for the bean. | true
scope | text |  | Define the scope of the action. "request" | "session" | "application" Valid options are: request session application Default value(s): request | false

### @jsf.converter (0..1)

Mark the class as implementation of JSF Converter interface

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | The unique id of the jsf converter which is used to reference it | true
description | text |  | An additional description, describing the converters usage | false

### @jsf.navigation (0..*)

specify navigation rules for the jsf application

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
from | text |  |  | true
to | text |  |  | true
result | text |  |  | true

### @jsf.render-kit (0..1)

Define a customer render kit

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
description | text |  | A description of the render kit | false
component-family | text |  | The component family of this render kit | false
renderer-type | text |  | The renderer type | false
renderer-class | text |  | The renderer class | false

### @jsf.validator (0..1)

Mark the class as implementation of JSF Validator interface

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | The unique id of the jsf validator which is used to reference it | true

## @jsf Method Level Tag Usage

### @jsf.managed-property (0..*)

Defines a managed property for a managed bean

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Define the name of the property | false
value | text |  | Define the initial value of the property | false
value-ref | text |  | Define the initial value of the property as reference | use value or value-ref property

### @jsf.validator-attribute (0..*)

mark the methode as getter methode for a validator attribute. Attribute name and type are read from the methode signature

## @jsf Field Level Tag Usage