| // Copyright 2010, 2013 The Apache Software Foundation |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package org.apache.tapestry5.annotations; |
| |
| import static java.lang.annotation.ElementType.PARAMETER; |
| import static java.lang.annotation.RetentionPolicy.RUNTIME; |
| import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.COMPONENT; |
| import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.MIXIN; |
| import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE; |
| |
| import java.lang.annotation.Documented; |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.Target; |
| |
| import org.apache.tapestry5.internal.transform.OnEventWorker; |
| import org.apache.tapestry5.ioc.annotations.UseWith; |
| import org.apache.tapestry5.ioc.services.TypeCoercer; |
| import org.apache.tapestry5.services.Request; |
| |
| /** |
| * Annotation that may be placed on parameters of event handler methods. |
| * Annotated parameters will be {@linkplain Request#getParameter(String) extracted from the request}, |
| * then {@linkplain org.apache.tapestry5.ValueEncoder converted} to the type of the parameter. Such parameters are separate |
| * from ordinary context parameters (extracted from the Request path). Typically, this is used when |
| * client-side JavaScript adds a query parameter to a request to communicate some information from the client |
| * side to the server side. |
| * <p> |
| * Individual fields may also be directly mapped to query parameters using the {@link ActivationRequestParameter} annotation. |
| * |
| * @since 5.2.0 |
| * @see OnEventWorker |
| */ |
| @Target( |
| { PARAMETER }) |
| @Retention(RUNTIME) |
| @Documented |
| @UseWith( |
| { COMPONENT, MIXIN, PAGE }) |
| public @interface RequestParameter |
| { |
| /** The name of the query parameter to extract from the request. */ |
| String value(); |
| |
| /** |
| * If false (the default), then an exception is thrown when the query parameter is read, if it is blank (null or an |
| * empty string). If true, then blank values are allowed and will be passed through the appropriate {@link org.apache.tapestry5.ValueEncoder} |
| * implementation. |
| */ |
| boolean allowBlank() default false; |
| } |