| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>FormParam</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FormParam"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/ws/rs/ForbiddenException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/ws/rs/GET.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/ws/rs/FormParam.html" target="_top">Frames</a></li> |
| <li><a href="FormParam.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.ws.rs</div> |
| <h2 title="Annotation Type FormParam" class="title">Annotation Type FormParam</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Target(value={PARAMETER,METHOD,FIELD}) |
| @Retention(value=RUNTIME) |
| @Documented |
| public @interface <span class="memberNameLabel">FormParam</span></pre> |
| <div class="block">Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter. Values |
| are URL decoded unless this is disabled using the <a href="../../../jakarta/ws/rs/Encoded.html" title="annotation in jakarta.ws.rs"><code>Encoded</code></a> annotation. A default value can be specified using |
| the <a href="../../../jakarta/ws/rs/DefaultValue.html" title="annotation in jakarta.ws.rs"><code>DefaultValue</code></a> annotation. If the request entity body is absent or is an unsupported media type, the |
| default value is used. |
| |
| The type <code>T</code> of the annotated parameter must either: |
| <ol> |
| <li>Be a primitive type</li> |
| <li>Have a constructor that accepts a single <code>String</code> argument</li> |
| <li>Have a static method named <code>valueOf</code> or <code>fromString</code> that accepts a single <code>String</code> argument |
| (see, for example, <code>Integer.valueOf(String)</code>)</li> |
| <li>Have a registered implementation of <a href="../../../jakarta/ws/rs/ext/ParamConverterProvider.html" title="interface in jakarta.ws.rs.ext"><code>ParamConverterProvider</code></a> JAX-RS extension SPI that |
| returns a <a href="../../../jakarta/ws/rs/ext/ParamConverter.html" title="interface in jakarta.ws.rs.ext"><code>ParamConverter</code></a> instance capable of a "from string" conversion for the type.</li> |
| <li>Be <code>List<T></code>, <code>Set<T></code> or <code>SortedSet<T></code>, where <code>T</code> satisfies 2, 3 or 4 above. The |
| resulting collection is read-only.</li> |
| </ol> |
| |
| <p> |
| If the type is not one of the collection types listed in 5 above and the form parameter is represented by multiple |
| values then the first value (lexically) of the parameter is used. |
| </p> |
| |
| <p> |
| If this annotation is used to bind form parameters, a JAX-RS implementation MUST use the entity provider API |
| to create a <a href="../../../jakarta/ws/rs/core/Form.html" title="class in jakarta.ws.rs.core"><code>Form</code></a> and derive the values from this instance. If there is at least one |
| <a href="../../../jakarta/ws/rs/FormParam.html" title="annotation in jakarta.ws.rs"><code>FormParam</code></a> for a resource method, JAX-RS implementations MUST support a <a href="../../../jakarta/ws/rs/core/Form.html" title="class in jakarta.ws.rs.core"><code>Form</code></a> |
| entity parameter for the same method. Support for other entity parameter types is OPTIONAL. |
| </p> |
| |
| <p> |
| Note that, whilst the annotation target permits use on fields and methods, this annotation is only required to be |
| supported on resource method parameters. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/DefaultValue.html" title="annotation in jakarta.ws.rs"><code>DefaultValue</code></a>, |
| <a href="../../../jakarta/ws/rs/Encoded.html" title="annotation in jakarta.ws.rs"><code>Encoded</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.required.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Required Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Required Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/FormParam.html#value--">value</a></span></code> |
| <div class="block">Defines the name of the form parameter whose value will be used to initialize the value of the annotated method |
| argument.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="value--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public abstract java.lang.String value</pre> |
| <div class="block">Defines the name of the form parameter whose value will be used to initialize the value of the annotated method |
| argument. The name is specified in decoded form, any percent encoded literals within the value will not be decoded |
| and will instead be treated as literal text. E.g. if the parameter name is "a b" then the value of the annotation is |
| "a b", <i>not</i> "a+b" or "a%20b".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>form parameter name.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/ws/rs/ForbiddenException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/ws/rs/GET.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/ws/rs/FormParam.html" target="_top">Frames</a></li> |
| <li><a href="FormParam.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
