Spec-Zone .ru спецификации, руководства, описания, API

javax.ws.rs
Тип аннотации PathParam

@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface PathParam

Связывает значение шаблонного параметра URI или сегмента пути, содержащего шаблонный параметр к параметру метода ресурса, полю class ресурса, или ресурсу бобовое свойство class. Значением является URL, декодируемый, если это не отключается, используя Encoded аннотация. Значение по умолчанию может быть определено, используя DefaultValue аннотация. Тип аннотируемого параметра, поля или свойства должен также:

• Быть PathSegment, значение будет заключительным сегментом соответствующей части пути. См. UriInfo для средства получения всех сегментов пути запроса.
• Быть List<PathSegment>, значение будет списком PathSegment соответствие сегменту (ам) пути, который соответствовал именованный шаблонный параметр. См. UriInfo для средства получения всех сегментов пути запроса.
• Будьте типом примитива.
• Имейте конструктора, который принимает единственный Строковый параметр.
• Назовите статический метод valueOf или fromString это принимает единственный Строковый параметр (см., например, Integer.valueOf(String)).

Введенное значение соответствует последнему использованию (с точки зрения контекста) параметра пути. Например, если class и метод подресурса оба аннотируются a Path содержа тот же самый URI обрабатывает по шаблону параметр, использование PathParam на подресурсе параметр метода свяжет значение, соответствующее шаблонный параметр URI в методе Path аннотация.

Поскольку инжекция происходит в объектное время создания, использование этой аннотации на поля class ресурса и бобовые свойства только поддерживается для значения по умолчанию ресурс на запрос жизненный цикл class. Классы ресурса, используя другие жизненные циклы должны только использовать эту аннотацию на параметры метода ресурса.

См. Также:

Encoded, DefaultValue, PathSegment, UriInfo

Необходимая Сводка Элемента

java.lang.String

значение Определяет имя шаблонного параметра URI, значение которого будет использоваться, чтобы инициализировать значение аннотируемого параметра метода, поля class или свойства.

Деталь элемента

значение

public abstract java.lang.String value

Определяет имя шаблонного параметра URI, значение которого будет использоваться, чтобы инициализировать значение аннотируемого параметра метода, поля class или свойства. См. Path#value() для описания синтаксиса шаблонных параметров.

Например, class, аннотируемый: @Path("widgets/{id}") могли аннотировать методы, параметры которых аннотируются @PathParam("id").