[jboss-cvs] JBossAS SVN: r105517 - projects/docs/enterprise/EAP/trunk/5.x/Seam_Reference_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue Jun 1 19:26:48 EDT 2010
Author: misty at redhat.com
Date: 2010-06-01 19:26:48 -0400 (Tue, 01 Jun 2010)
New Revision: 105517
Modified:
projects/docs/enterprise/EAP/trunk/5.x/Seam_Reference_Guide/en-US/Annotations.xml
Log:
JBPAPP-4387
Modified: projects/docs/enterprise/EAP/trunk/5.x/Seam_Reference_Guide/en-US/Annotations.xml
===================================================================
--- projects/docs/enterprise/EAP/trunk/5.x/Seam_Reference_Guide/en-US/Annotations.xml 2010-06-01 22:54:37 UTC (rev 105516)
+++ projects/docs/enterprise/EAP/trunk/5.x/Seam_Reference_Guide/en-US/Annotations.xml 2010-06-01 23:26:48 UTC (rev 105517)
@@ -20,7 +20,7 @@
<term> <literal>@Name</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Name("componentName")]]></programlisting>
+<programlisting language="Java" role="JAVA">@Name("componentName")</programlisting>
<para>
Defines the Seam component name for a class. This annotation is required for all Seam components.
</para>
@@ -30,8 +30,7 @@
<term> <literal>@Scope</literal> </term>
<listitem>
- <programlisting language="Java" role="JAVA"><![CDATA[@Scope(ScopeType.CONVERSATION)
- ]]></programlisting>
+ <programlisting language="Java" role="JAVA">@Scope(ScopeType.CONVERSATION)</programlisting>
<para>
Defines the default context of the component. The possible values are defined by the <literal>ScopeType</literal> enumeration: <literal>EVENT</literal>, <literal>PAGE</literal>, <literal>CONVERSATION</literal>, <literal>SESSION</literal>, <literal>BUSINESS_PROCESS</literal>, <literal>APPLICATION</literal>, or <literal>STATELESS</literal>.
</para>
@@ -44,7 +43,7 @@
<term> <literal>@Role</literal> </term>
<listitem>
- <programlisting language="Java" role="JAVA"><![CDATA[@Role(name="roleName", scope=ScopeType.SESSION)]]></programlisting>
+ <programlisting language="Java" role="JAVA">@Role(name="roleName", scope=ScopeType.SESSION)</programlisting>
<para>
Allows a Seam component to be bound to multiple context variables. The <literal>@Name</literal> and <literal>@Scope</literal> annotations define a <emphasis>default role</emphasis>. Each <literal>@Role</literal> annotation defines an additional role.
</para>
@@ -66,9 +65,7 @@
<term> <literal>@Roles</literal> </term>
<listitem>
- <programlisting language="Java" role="JAVA"><![CDATA[@Roles({ @Role(name="user", scope=ScopeType.CONVERSATION),
- @Role(name="currentUser", scope=ScopeType.SESSION) })
- ]]></programlisting>
+ <programlisting language="Java" role="JAVA">@Roles({ @Role(name="user", scope=ScopeType.CONVERSATION), @Role(name="currentUser", scope=ScopeType.SESSION) })</programlisting>
<para>
Allows you to specify multiple additional roles.
</para>
@@ -78,8 +75,7 @@
<term> <literal>@BypassInterceptors</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@BypassInterceptors
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@BypassInterceptors</programlisting>
<para>
Disables all Seam interceptors on a particular component or component method.
</para>
@@ -89,8 +85,7 @@
<term> <literal>@JndiName</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@JndiName("my/jndi/name")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@JndiName("my/jndi/name")</programlisting>
<para>
Specifies the JNDI name that Seam will use to look up the EJB component. If no JNDI name is explicitly specified, Seam will use the JNDI pattern specified by <literal>org.jboss.seam.core.init.jndiPattern</literal>.
</para>
@@ -100,8 +95,7 @@
<term> <literal>@Conversational</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Conversational
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Conversational</programlisting>
<para>
Specifies that a conversation scope component is conversational, meaning that no method of the component may be called unless a long-running conversation is active.
</para>
@@ -111,8 +105,7 @@
<term> <literal>@PerNestedConversation</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@PerNestedConversation
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@PerNestedConversation</programlisting>
<para>
Limits the scope of a conversation-scoped component to the parent conversation in which it was instantiated. The component instance will not be visible to nested child conversations, which will operate within their own instances.
</para>
@@ -127,16 +120,12 @@
<term> <literal>@Startup</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Scope(APPLICATION)
- at Startup(depends="org.jboss.seam.bpm.jbpm")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Scope(APPLICATION) @Startup(depends="org.jboss.seam.bpm.jbpm")</programlisting>
<para>
Specifies that an application-scoped component will start immediately at initialization time. This is used for built-in components that bootstrap critical infrastructure, such as JNDI, datasources, etc.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Scope(SESSION)
- at Startup
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Scope(SESSION) @Startup</programlisting>
<para>
Specifies that a session-scoped component will start immediately at session creation time.
</para>
@@ -152,33 +141,28 @@
<varlistentry id="install-annotation">
<term> <literal>@Install</literal> </term>
<listitem>
-
-<programlisting language="Java" role="JAVA"><![CDATA[@Install(false)
-]]></programlisting>
+
+<programlisting language="Java" role="JAVA">@Install(false)</programlisting>
<para>
Specifies that a component should not be installed by default. (If you do not specify this annotation, the component will be installed.)
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Install(dependencies="org.jboss.seam.bpm.jbpm")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Install(dependencies="org.jboss.seam.bpm.jbpm")</programlisting>
<para>
Specifies that a component should only be installed if the components listed as dependencies are also installed.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Install(genericDependencies=ManagedQueueSender.class)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Install(genericDependencies=ManagedQueueSender.class)</programlisting>
<para>
Specifies that a component should only be installed if a component that is implemented by a certain class is installed. This is useful when a required dependency does not have a single well-known name.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Install(classDependencies="org.hibernate.Session")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Install(classDependencies="org.hibernate.Session")</programlisting>
<para>
Specifies that a component should only be installed if the named class is included on the classpath.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Install(precedence=BUILT_IN)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Install(precedence=BUILT_IN)</programlisting>
<para>
Specifies the precedence of the component. If multiple components with the same name exist, the one with the higher precedence will be installed. The defined precendence values are (in ascending order):
</para>
@@ -215,8 +199,7 @@
<term> <literal>@Synchronized</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Synchronized(timeout=1000)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Synchronized(timeout=1000)</programlisting>
<para>
Specifies that a component is accessed concurrently by multiple clients, and that Seam should serialize requests. If a request is not able to obtain its lock on the component in the given timeout period, an exception will be raised.
</para>
@@ -226,8 +209,7 @@
<term> <literal>@ReadOnly</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@ReadOnly
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@ReadOnly</programlisting>
<para>
Specifies that a JavaBean component or component method does not require state replication at the end of the invocation.
</para>
@@ -237,8 +219,7 @@
<term> <literal>@AutoCreate</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@AutoCreate
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@AutoCreate</programlisting>
<para>
Specifies that a component will be automatically created, even if the client does not specify <literal>create=true</literal>.
</para>
@@ -257,32 +238,27 @@
<term> <literal>@In</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@In
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@In</programlisting>
<para>
Specifies that a component attribute is to be injected from a context variable at the beginning of each component invocation. If the context variable is null, an exception will be thrown.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@In(required=false)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@In(required=false)</programlisting>
<para>
Specifies that a component attribute is to be injected from a context variable at the beginning of each component invocation. The context variable may be null.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@In(create=true)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@In(create=true)</programlisting>
<para>
Specifies that a component attribute is to be injected from a context variable at the beginning of each component invocation. If the context variable is null, an instance of the component is instantiated by Seam.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@In(value="contextVariableName")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@In(value="contextVariableName")</programlisting>
<para>
Specifies the name of the context variable explicitly, instead of using the annotated instance variable name.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@In(value="#{customer.addresses['shipping']}")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@In(value="#{customer.addresses['shipping']}")</programlisting>
<para>
Specifies that a component attribute is to be injected by evaluating a JSF EL expression at the beginning of each component invocation.
</para>
@@ -309,20 +285,17 @@
<term> <literal>@Out</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Out
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Out </programlisting>
<para>
Specifies that a component attribute that is a Seam component is to be outjected to its context variable at the end of the invocation. If the attribute is null, an exception is thrown.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Out(required=false)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Out(required=false)</programlisting>
<para>
Specifies that a component attribute that is a Seam component is to be outjected to its context variable at the end of the invocation. The attribute can be null.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Out(scope=ScopeType.SESSION)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Out(scope=ScopeType.SESSION)</programlisting>
<para>
Specifies that a component attribute that is <emphasis>not</emphasis> a Seam component type is to be outjected to a specific scope at the end of the invocation.
</para>
@@ -330,8 +303,7 @@
Alternatively, if no scope is explicitly specified, the scope of the component with the <literal>@Out</literal> attribute isused (or the <literal>EVENT</literal> scope if the component is stateless).
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Out(value="contextVariableName")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Out(value="contextVariableName")</programlisting>
<para>
Specifies the name of the context variable explicitly, instead of using the annotated instance variable name.
</para>
@@ -354,9 +326,8 @@
These annotations commonly occur together, as in the following example:
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@In(create=true)
- at Out private User currentUser;
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@In(create=true)
+ at Out private User currentUser;</programlisting>
<para>
The next annotation supports the <emphasis>manager component</emphasis> pattern, where a Seam component manages the lifecycle of an instance of some other class that is to be injected. It appears on a component getter method.
</para>
@@ -365,8 +336,7 @@
<term> <literal>@Unwrap</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Unwrap
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Unwrap</programlisting>
<para>
Specifies that the object returned by the annotated getter method will be injected instead of the component.
</para>
@@ -381,16 +351,14 @@
<term> <literal>@Factory</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Factory("processInstance")
-public void createProcessInstance() { ... }
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Factory("processInstance")
+public void createProcessInstance() { ... }</programlisting>
<para>
Specifies that the component method be used to initialize the value of the named context variable, when the context variable has no value. This style is used with methods that return <literal>void</literal>.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Factory("processInstance", scope=CONVERSATION)
-public ProcessInstance createProcessInstance() { ... }
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Factory("processInstance", scope=CONVERSATION)
+public ProcessInstance createProcessInstance() { ... }</programlisting>
<para>
Specifies that the value returned by the method should be used to initialize the value of the named context variable, if the context variable has no value. This style is used with methods that return a value. If no scope is explicitly specified, the scope of the component with the <literal>@Factory</literal> method is used (unless the component is stateless, in which case the <literal>EVENT</literal> context is used).
</para>
@@ -422,8 +390,7 @@
<term> <literal>@Logger</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Logger("categoryName")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Logger("categoryName")</programlisting>
<para>
Specifies that a component field is to be injected with an instance of <literal>org.jboss.seam.log.Log</literal>. For entity beans, the field must be declared as <literal>static</literal>.
</para>
@@ -445,8 +412,7 @@
<term> <literal>@RequestParameter</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@RequestParameter("parameterName")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@RequestParameter("parameterName")</programlisting>
<para>
Specifies that a component attribute is to be injected with the value of a request parameter. Basic type conversions are performed automatically.
</para>
@@ -472,8 +438,7 @@
<term> <literal>@Create</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Create
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Create</programlisting>
<para>
Specifies that the method should be called when an instance of the component is instantiated by Seam. Create methods are only supported for JavaBeans and stateful session beans.
</para>
@@ -483,8 +448,7 @@
<term> <literal>@Destroy</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Destroy
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Destroy</programlisting>
<para>
Specifies that the method should be called when the context ends and its context variables are destroyed. Destroy methods are only supported for JavaBeans and stateful session beans.
</para>
@@ -497,14 +461,12 @@
<term> <literal>@Observer</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Observer("somethingChanged")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Observer("somethingChanged")</programlisting>
<para>
Specifies that the method should be called when a component-driven event of the specified type occurs.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Observer(value="somethingChanged",create=false)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Observer(value="somethingChanged",create=false)</programlisting>
<para>
Specifies that the method should be called when an event of the specified type occurs, but that an instance should not be created if it does not already exist. If an instance does not exist and create is set to <literal>false</literal>, the event will not be observed. The default value is <literal>true</literal>.
</para>
@@ -526,32 +488,27 @@
<term> <literal>@Begin</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Begin
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Begin</programlisting>
<para>
Specifies that a long-running conversation begins when this method returns a non-null outcome without exception.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Begin(join=true)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Begin(join=true)</programlisting>
<para>
Specifies that, if a long-running conversation is already in progress, the conversation context is propagated.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Begin(nested=true)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Begin(nested=true)</programlisting>
<para>
Specifies that, if a long-running conversation is already in progress, a new <emphasis>nested</emphasis> conversation context should begin. The nested conversation will end when the next <literal>@End</literal> is encountered, and the outer conversation will resume. Multiple nested conversations can exist concurrently in the same outere conversation.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Begin(pageflow="process definition name")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Begin(pageflow="process definition name")</programlisting>
<para>
Specifies a jBPM process definition name that defines the pageflow for this conversation.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Begin(flushMode=FlushModeType.MANUAL)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Begin(flushMode=FlushModeType.MANUAL)</programlisting>
<para>
Specifies the flush mode of any Seam-managed persistence contexts. <literal>flushMode=FlushModeType.MANUAL</literal> supports the use of <emphasis>atomic conversations</emphasis>, where all write operations are queued in the conversation context until an explicit call to <literal>flush()</literal> (which usually occurs at the end of the conversation) is made.
</para>
@@ -583,8 +540,7 @@
<term> <literal>@End</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@End
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@End</programlisting>
<para>
Specifies that a long-running conversation ends when this method returns a non-null outcome without exception.
</para>
@@ -606,8 +562,7 @@
<term> <literal>@StartTask</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@StartTask
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@StartTask</programlisting>
<para>
Starts a jBPM task. Specifies that a long-running conversation begins when this method returns a non-null outcome without exception. This conversation is associated with the jBPM task specified in the named request parameter. Within the context of this conversation, a business process context is also defined, for the business process instance of the task instance.
</para>
@@ -634,8 +589,7 @@
<term> <literal>@BeginTask</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@BeginTask
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@BeginTask</programlisting>
<para>
Resumes work on an incomplete jBPM task. Specifies that a long-running conversation begins when this method returns a non-null outcome without exception. This conversation is associated with the jBPM task specified in the named request parameter. Within the context of this conversation, a business process context is also defined, for the business process instance of the task instance.
</para>
@@ -662,14 +616,12 @@
<term> <literal>@EndTask</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@EndTask
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@EndTask</programlisting>
<para>
Ends a jBPM task. Specifies that a long-running conversation ends when this method returns a non-null outcome, and that the current task is complete. Triggers a jBPM transition. The actual transition triggered will be the default transition unless the application has called <literal>Transition.setName()</literal> on the built-in component named <literal>transition</literal>.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@EndTask(transition="transitionName")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@EndTask(transition="transitionName")</programlisting>
<para>
Triggers the specified jBPM transition.
</para>
@@ -691,8 +643,7 @@
<term> <literal>@CreateProcess</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@CreateProcess(definition="process definition name")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@CreateProcess(definition="process definition name")</programlisting>
<para>
Creates a new jBPM process instance when the method returns a non-null outcome without exception. The <literal>ProcessInstance</literal> object will be available in a context variable named <literal>processInstance</literal>.
</para>
@@ -709,8 +660,7 @@
<term> <literal>@ResumeProcess</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@ResumeProcess(processIdParameter="processId")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@ResumeProcess(processIdParameter="processId")</programlisting>
<para>
Re-enters the scope of an existing jBPM process instance when the method returns a non-null outcome without exception. The <literal>ProcessInstance</literal> object will be available in a context variable named <literal>processInstance</literal>.
</para>
@@ -727,8 +677,7 @@
<term> <literal>@Transition</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Transition("cancel")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Transition("cancel")</programlisting>
<para>
Marks a method as signalling a transition in the current jBPM process instance whenever the method returns a non-null result.
</para>
@@ -747,8 +696,7 @@
<term> <literal>@Transactional</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Transactional
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Transactional</programlisting>
<para>
Specifies that a JavaBean component should have similar transactional behavior to the default behavior of a session bean component. That is, method invocations should take place in a transaction, and if no transaction exists when the method is called, a transaction will be started just for that method. This annotation can be applied at either class or method level.
</para>
@@ -763,8 +711,7 @@
<term> <literal>@ApplicationException</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@ApplicationException
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@ApplicationException</programlisting>
<para>
Applied to an exception to denote that it is an application exception and should be reported to the client directly — that is, unwrapped. Operates identically to <literal>javax.ejb.ApplicationException</literal> when used in a pre-Java EE 5 environment.
</para>
@@ -791,8 +738,7 @@
<term> <literal>@Interceptors</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Interceptors({DVDInterceptor, CDInterceptor})
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Interceptors({DVDInterceptor, CDInterceptor})</programlisting>
<para>
Declares an ordered list of interceptors for a class or method. Operates identically to <literal>javax.interceptors.Interceptors</literal> when used in a pre-Java EE 5 environment. Note that this may only be used as a meta-annotation.
</para>
@@ -819,8 +765,7 @@
<term> <literal>@Redirect</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Redirect(viewId="error.jsp")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Redirect(viewId="error.jsp")</programlisting>
<para>
Specifies that the annotated exception causes a browser redirect to a specified view ID.
</para>
@@ -847,8 +792,7 @@
<term> <literal>@HttpError</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@HttpError(errorCode=404)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@HttpError(errorCode=404)</programlisting>
<para>
Specifies that the annotated exception causes a HTTP error to be sent.
</para>
@@ -884,8 +828,7 @@
<term> <literal>@WebRemote</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@WebRemote(exclude="path.to.exclude")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@WebRemote(exclude="path.to.exclude")</programlisting>
<para>
Indicates that the annotated method may be called from client-side JavaScript. The <literal>exclude</literal> property is optional, and allows objects to be excluded from the result's object graph. (See the <xref linkend="remoting" /> chapter for more details.)
</para>
@@ -907,26 +850,22 @@
<term> <literal>@Interceptor</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Interceptor(stateless=true)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Interceptor(stateless=true)</programlisting>
<para>
Specifies that this interceptor is stateless and Seam may optimize replication.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Interceptor(type=CLIENT)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Interceptor(type=CLIENT)</programlisting>
<para>
Specifies that this interceptor is a "client-side" interceptor, called prior to the EJB container.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Interceptor(around={SomeInterceptor.class, OtherInterceptor.class})
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Interceptor(around={SomeInterceptor.class, OtherInterceptor.class})</programlisting>
<para>
Specifies that this interceptor is positioned higher in the stack than the given interceptors.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Interceptor(within={SomeInterceptor.class, OtherInterceptor.class})
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Interceptor(within={SomeInterceptor.class, OtherInterceptor.class})</programlisting>
<para>
Specifies that this interceptor is positioned deeper in the stack than the given interceptors.
</para>
@@ -941,26 +880,22 @@
The following annotations are used to declare an asynchronous method, as in the following example:
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Asynchronous public void scheduleAlert(Alert alert,
+<programlisting language="Java" role="JAVA">@Asynchronous public void scheduleAlert(Alert alert,
@Expiration Date date) {
...
-}
-]]>
-</programlisting>
+}</programlisting>
-<programlisting language="Java" role="JAVA"><![CDATA[@Asynchronous public Timer scheduleAlerts(Alert alert,
+<programlisting language="Java" role="JAVA">@Asynchronous public Timer scheduleAlerts(Alert alert,
@Expiration Date date,
@IntervalDuration long interval) {
...
-}
-]]></programlisting>
+}</programlisting>
<variablelist>
<varlistentry id="asynchronous-annotation">
<term> <literal>@Asynchronous</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Asynchronous
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Asynchronous</programlisting>
<para>
Specifies that the method call is processed asynchronously.
</para>
@@ -970,8 +905,7 @@
<term> <literal>@Duration</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Duration
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Duration</programlisting>
<para>
Specifies the parameter of the asynchronous call that relates to the duration before the call is processed (or first processed, for recurring calls).
</para>
@@ -981,8 +915,7 @@
<term> <literal>@Expiration</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Expiration
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Expiration</programlisting>
<para>
Specifies the parameter of the asynchronous call that relates to the date and time at which the call is processed (or first processed, for recurring calls).
</para>
@@ -992,8 +925,7 @@
<term> <literal>@IntervalDuration</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@IntervalDuration
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@IntervalDuration</programlisting>
<para>
Specifies that an asynchronous method call recurs. The associated parameter defines the duration of the interval between recurrences.
</para>
@@ -1054,8 +986,7 @@
<term> <literal>@DataModel</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@DataModel("variableName")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@DataModel("variableName")</programlisting>
<para>
Outjects a property of type <literal>List</literal>, <literal>Map</literal>, <literal>Set</literal> or <literal>Object[]</literal> as a JSF <literal>DataModel</literal> into the scope of the owning component (or the <literal>EVENT</literal> scope, if the owning component is <literal>STATELESS</literal>). In the case of <literal>Map</literal>, each row of the <literal>DataModel</literal> is a <literal>Map.Entry</literal>.
</para>
@@ -1077,8 +1008,7 @@
<term> <literal>@DataModelSelection</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@DataModelSelection
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@DataModelSelection</programlisting>
<para>
Injects the selected value from the JSF <literal>DataModel</literal>. (This is the element of the underlying collection, or the map value.) If only one <literal>@DataModel</literal> attribute is defined for a component, the selected value from that <literal>DataModel</literal> will be injected. Otherwise, the component name of each <literal>@DataModel</literal> must be specified in the value attribute for each <literal>@DataModelSelection</literal>.
</para>
@@ -1098,8 +1028,7 @@
<term> <literal>@DataModelSelectionIndex</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@DataModelSelectionIndex
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@DataModelSelectionIndex</programlisting>
<para>
Exposes the selection index of the JSF <literal>DataModel</literal> as an attribute of the component. (This is the row number of the underlying collection, or the map key.) If only one <literal>@DataModel</literal> attribute is defined for a component, the selected value from that <literal>DataModel</literal> will be injected. Otherwise, the component name of each <literal>@DataModel</literal> must be specified in the value attribute for each <literal>@DataModelSelectionIndex</literal>.
</para>
@@ -1127,8 +1056,7 @@
<term> <literal>@DataBinderClass</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@DataBinderClass(DataModelBinder.class)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@DataBinderClass(DataModelBinder.class)</programlisting>
<para>
Specifies that an annotation is a databinding annotation.
</para>
@@ -1138,8 +1066,7 @@
<term> <literal>@DataSelectorClass</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@DataSelectorClass(DataModelSelector.class)
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@DataSelectorClass(DataModelSelector.class)</programlisting>
<para>
Specifies that an annotation is a dataselection annotation.
</para>
@@ -1158,16 +1085,13 @@
<term> <literal>@Namespace</literal> </term>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Namespace(value="http://jboss.com/products/seam/example/seampay")
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Namespace(value="http://jboss.com/products/seam/example/seampay")</programlisting>
<para>
Specifies that components in the current package are associated with the given namespace. The declared namespace can be used as an XML namespace in a <filename>components.xml</filename> file to simplify application configuration.
</para>
-<programlisting language="Java" role="JAVA"><![CDATA[@Namespace(value="http://jboss.com/products/seam/core",
- prefix="org.jboss.seam.core")
-]]>
-</programlisting>
+<programlisting language="Java" role="JAVA">@Namespace(value="http://jboss.com/products/seam/core",
+ prefix="org.jboss.seam.core")</programlisting>
<para>
Specifies a namespace to associate with a given package. Additionally, it specifies a component name prefix to be applied to component names specified in the XML file. For example, an XML element named <literal>init</literal> that is associated with this namespace would be understood to actually refer to a component named <literal>org.jboss.seam.core.init</literal>.
</para>
@@ -1191,16 +1115,14 @@
<itemizedlist>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Filter(around={"seamComponent", "otherSeamComponent"})
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Filter(around={"seamComponent", "otherSeamComponent"})</programlisting>
<para>
Specifies that this filter is positioned higher in the stack than the given filters.
</para>
</listitem>
<listitem>
-<programlisting language="Java" role="JAVA"><![CDATA[@Filter(within={"seamComponent", "otherSeamComponent"})
-]]></programlisting>
+<programlisting language="Java" role="JAVA">@Filter(within={"seamComponent", "otherSeamComponent"})</programlisting>
<para>
Specifies that this filter is positioned deeper in the stack than the given filters.
</para>
More information about the jboss-cvs-commits
mailing list