org.richfaces.cdk.annotations

Annotation Type JsfConverter

@Retention(value=SOURCE)
@Target(value=TYPE)
public @interface JsfConverter

This annotation defines concrete class as JSF Converter, or abstract class as the base for generated Converter implementation.

Author:

asmirnov@exadel.com

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	attributes Defines file names for fragment of faces-config.xml that contain standard attribute definitions.
Description	description Converter description to include into generated faces-config and taglib.
Class<?>	forClass represents the class for which a Converter class will be registered.
String	generate fully qualified class name of the generated Converter implementation.
String	id The "converter-id" element represents the identifier under which the corresponding Converter class should be registered.
Class<?>[]	interfaces Interfaces that should be implemented in the generated class.
Tag[]	tag Tag description.

Element Detail

id

public abstract String id

The "converter-id" element represents the identifier under which the corresponding Converter class should be registered.

Returns:

converter-id

Default:

""

forClass

public abstract Class<?> forClass

represents the class for which a Converter class will be registered.

Returns:

Default:

org.richfaces.cdk.annotations.JsfConverter.NONE.class

generate

public abstract String generate

fully qualified class name of the generated Converter implementation. Default value means nothing to genrate from concrete class, or infer name by convention for abstract class.

Returns:

Default:

""

description

public abstract Description description

Converter description to include into generated faces-config and taglib.

Returns:

Default:

@org.richfaces.cdk.annotations.Description

tag

public abstract Tag[] tag

Tag description. If generated tags require special handlers, provide separate description for every type of tag, JSP and Facelets. Otherwise, the only one tag tag description with name and type TagType.All.

Returns:

Default:

{}

attributes

public abstract String[] attributes

Defines file names for fragment of faces-config.xml that contain standard attribute definitions. All names relative to the META-INF/cdk/attributes/ folder in classpath. CDK also tries to read META-INF/cdk/attributes/[classname].xml file for all component superclasses and interfaces. Therefore, it is not necessary to explicitly include definitions for Converter and any other standard JSF classes.

Returns:

Default:

{}

interfaces

public abstract Class<?>[] interfaces

Interfaces that should be implemented in the generated class. CDK processes all Attribute annotations in these interfaces

Returns:

Default:

{}