org.apache.myfaces.buildtools.maven2.plugin.builder.annotation
Annotation Type JSFValidator


@Documented
@Target(value=TYPE)
@Retention(value=SOURCE)
public @interface JSFValidator

Used to define a jsf validator.

Version:
$Revision: 1024440 $ $Date: 2010-10-19 17:34:33 -0500 (Tue, 19 Oct 2010) $
Author:
Leonardo Uribe (latest modification by $Author: lu4242 $)

Optional Element Summary
 java.lang.String bodyContent
          Indicate if the element accept inner elements or not.
 java.lang.String clazz
          The fully-qualified-name of a concrete validator class.
 boolean configExcluded
          Indicate that this component should not be defined on faces-config.xml.
 java.lang.String desc
          Short description
 boolean evaluateELOnExecution
          Indicate that the EL Expressions should be stored using setValueExpression() method, instead evaluate them at build view time.
 java.lang.String id
          Indicate the validatorId which identifies this class.
 java.lang.String name
          The name of the component in a page (ex: x:mycomp).
 java.lang.String serialuidtag
          Serial uid that should be added on generated tag class
 java.lang.String tagClass
          The tag class used for this validator, if applies.
 java.lang.String tagHandler
          Indicate tag handler class used for this component on facelets.
 java.lang.String tagSuperclass
          Tag super class that inherits the tag class
 

id

public abstract java.lang.String id
Indicate the validatorId which identifies this class. If not defined, it tries to get the value of the field VALIDATOR_ID.

Default:
""

name

public abstract java.lang.String name
The name of the component in a page (ex: x:mycomp).

Default:
""

tagClass

public abstract java.lang.String tagClass
The tag class used for this validator, if applies.

Default:
""

tagSuperclass

public abstract java.lang.String tagSuperclass
Tag super class that inherits the tag class

Default:
""

configExcluded

public abstract boolean configExcluded
Indicate that this component should not be defined on faces-config.xml. Anyway, if this is true or false does not have any significative impact.

Returns:
Default:
false

bodyContent

public abstract java.lang.String bodyContent
Indicate if the element accept inner elements or not.

Default:
""

desc

public abstract java.lang.String desc
Short description

Default:
""

serialuidtag

public abstract java.lang.String serialuidtag
Serial uid that should be added on generated tag class

Since:
1.0.3
Default:
""

clazz

public abstract java.lang.String clazz
The fully-qualified-name of a concrete validator class.

This attribute is only relevant when "name" is also set, ie the annotation is indicating that a validator is really being declared.

When this attribute is not defined then it is assumed that this annotated class is the actual validator class.

When this attribute is set to something other than the name of the annotated class then the specified class is the one that the JSF validator registration in faces-config.xml will refer to. And if that class does not exist in the classpath (which will normally be the case) then code-generation will be triggered to create it.

This attribute is not inheritable.

The doclet-annotation equivalent of this attribute is named "class".

Since:
1.0.3
Default:
""

tagHandler

public abstract java.lang.String tagHandler
Indicate tag handler class used for this component on facelets.

Since:
1.0.7
Default:
""

evaluateELOnExecution

public abstract boolean evaluateELOnExecution
Indicate that the EL Expressions should be stored using setValueExpression() method, instead evaluate them at build view time. Later the EL Expressions will be evaluated according to their needs

Since:
1.0.7
Default:
false


Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.