All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.ws.rs.FormParam Maven / Gradle / Ivy

There is a newer version: 2.0.1
Show newest version
/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the "License").  You may not use this file except
 * in compliance with the License.
 * 
 * You can obtain a copy of the license at
 * http://www.opensource.org/licenses/cddl1.php
 * See the License for the specific language governing
 * permissions and limitations under the License.
 */

/*
 * FormParam.java
 *
 * Created on November 16, 2006, 2:04 PM
 *
 */

package javax.ws.rs;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 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 {@link Encoded} annotation. A default value can be
 * specified using the {@link DefaultValue} annotation.
 * If the request entity body is absent or is an unsupported media type, the
 * default value is used.
 * 
 * The type T of the annotated parameter must either:
 * 
    *
  1. Be a primitive type
  2. *
  3. Have a constructor that accepts a single String argument
  4. *
  5. Have a static method named valueOf or fromString * that accepts a single * String argument (see, for example, {@link Integer#valueOf(String)})
  6. *
  7. Be List<T>, Set<T> or * SortedSet<T>, where T satisfies 2 or 3 above. * The resulting collection is read-only.
  8. *
* *

If the type is not one of those listed in 4 above then the first value * (lexically) of the parameter is used.

* *

Note that, whilst the annotation target permits use on fields and methods, * this annotation is only required to be supported on resource method * parameters.

* * @see DefaultValue * @see Encoded */ @Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) public @interface FormParam { /** * 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", * not "a+b" or "a%20b". */ String value(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy