Updated Branches: refs/heads/master 4f70b71e8 -> 9e40372c1
Minor JavaDoc improvements Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/9e40372c Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/9e40372c Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/9e40372c Branch: refs/heads/master Commit: 9e40372c121637725edbf94a918502c25b09ba29 Parents: d639959 Author: Howard M. Lewis Ship <[email protected]> Authored: Mon Jan 14 10:57:31 2013 -0800 Committer: Howard M. Lewis Ship <[email protected]> Committed: Mon Jan 14 10:57:31 2013 -0800 ---------------------------------------------------------------------- .../java/org/apache/tapestry5/ValueEncoder.java | 8 +++++--- .../annotations/ActivationRequestParameter.java | 3 ++- .../tapestry5/annotations/RequestParameter.java | 7 ++++--- 3 files changed, 11 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/9e40372c/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java b/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java index f3e3f4d..c781be6 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/ValueEncoder.java @@ -1,4 +1,4 @@ -// Copyright 2007, 2008, 2011 The Apache Software Foundation +// Copyright 2007-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. @@ -29,8 +29,8 @@ package org.apache.tapestry5; * Tapestry can automatically generate ValueEncoders for enums as well as * Collections of any object types for which a coercion can be found from a * formatted String, such as primitives, primitive wrappers, Dates, Calendars, - * "name=value" strings, and any types for which a custom coercion has been - * contributed. + * "name=value" strings, and any types for which a {@linkplain org.apache.tapestry5.ioc.services.TypeCoercer + * custom type coercion} has been contributed. * <p/> * Custom ValueEncoder implementations will need to be supplied for entity type * objects. In such cases the {@link #toClient(Object)} method typically returns @@ -60,6 +60,8 @@ package org.apache.tapestry5; * @see org.apache.tapestry5.services.ValueEncoderSource * @see org.apache.tapestry5.services.ValueEncoderFactory * @see org.apache.tapestry5.annotations.PageActivationContext + * @see org.apache.tapestry5.annotations.RequestParameter + * @see org.apache.tapestry5.annotations.ActivationRequestParameter */ public interface ValueEncoder<V> { http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/9e40372c/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java index daf3725..d5f8086 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/ActivationRequestParameter.java @@ -1,4 +1,4 @@ -// Copyright 2010 The Apache Software Foundation +// 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. @@ -49,6 +49,7 @@ import org.apache.tapestry5.services.ValueEncoderSource; * <em>not</em> affect annotated fields, only assigning them back to null will. * * @see RequestParameter + * @see ValueEncoder */ @Target( { ElementType.FIELD }) http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/9e40372c/tapestry-core/src/main/java/org/apache/tapestry5/annotations/RequestParameter.java ---------------------------------------------------------------------- diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/RequestParameter.java b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/RequestParameter.java index b3e1b0a..ac72f8a 100644 --- a/tapestry-core/src/main/java/org/apache/tapestry5/annotations/RequestParameter.java +++ b/tapestry-core/src/main/java/org/apache/tapestry5/annotations/RequestParameter.java @@ -1,4 +1,4 @@ -// Copyright 2010 The Apache Software Foundation +// 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. @@ -32,7 +32,7 @@ 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 TypeCoercer coerced} to the type of the parameter. Such parameters are separate + * 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. @@ -55,7 +55,8 @@ public @interface RequestParameter /** * 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. + * 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; }
