javax.ws.rs.core
Класс UriBuilder

java.lang.Object
  расширенный javax.ws.rs.core.UriBuilder

public abstract class UriBuilder
расширяет java.lang. Объект

Шаблон URI осведомленная утилита class для создания URI от их компонентов. См. Path.value() для объяснения шаблонов URI.

Методы разработчика выполняют контекстное кодирование символов, не разрешенных в соответствующем компоненте URI после правил application/x-www-form-urlencoded типа носителей для параметров запроса и RFC 3986 для всех других компонентов. Отметьте, что только символы, не разрешенные в определенном компоненте, подвергаются кодированию так, например, путь, предоставленный одному из path методы могут содержать параметры матрицы или сегменты разнообразного пути, так как разделители являются юридическими символами и не будут закодированы. Процент закодированные значения также распознаются где позволено и не будут двойные закодированный.

Шаблоны URI позволяются в большинстве компонентов URI, но их значение ограничивается определенному компоненту. Например.

UriBuilder.fromPath("{arg1}").build("foo#bar");
привел бы к кодированию '#' так, что, получающийся URI является "foo%23bar". Создать URI "foo#bar" использование
UriBuilder.fromPath("{arg1}").fragment("{arg2}").build("foo", "bar")
вместо этого. Шаблонные имена URI и разделители никогда не кодируются, но их значения кодируются, когда URI создается. Шаблонные регулярные выражения параметра игнорируются, создавая URI, то есть никакая проверка допустимости не выполняется.

См. Также:
URI, Path

Сводка конструктора
protected UriBuilder()
          Защищенный конструктор, используйте одни из помех fromXXX методы, чтобы получить экземпляр.
 
Сводка метода
abstract  java.net.URI build(java.lang.Object... values)
          Создайте URI, используя предоставленные значения, чтобы заменить любые шаблонные параметры URI.
abstract  java.net.URI buildFromEncoded(java.lang.Object... values)
          Создайте URI.
abstract  java.net.URI buildFromEncodedMap(java.util.Map<java.lang.String,? extends java.lang.Object> values)
          Создайте URI, любые шаблонные параметры URI будут заменены значением в предоставленной карте.
abstract  java.net.URI buildFromMap(java.util.Map<java.lang.String,? extends java.lang.Object> values)
          Создайте URI, любые шаблонные параметры URI будут заменены значением в предоставленной карте.
abstract  UriBuilder clone()
          Создайте копию UriBuilder, сохраняющего его состояние.
abstract  UriBuilder fragment(java.lang.String fragment)
          Установите фрагмент URI.
static UriBuilder fromPath(java.lang.String path)
          Создайте новый экземпляр, представляющий относительный URI, инициализированный от пути URI.
static UriBuilder fromResource(java.lang.Class<?> resource)
          Создайте новый экземпляр, представляющий относительный URI, инициализированный от корневого ресурса class.
static UriBuilder fromUri(java.lang.String uri)
          Создайте новый экземпляр, инициализированный из существующего URI.
static UriBuilder fromUri(java.net.URI uri)
          Создайте новый экземпляр, инициализированный из существующего URI.
abstract  UriBuilder host(java.lang.String host)
          Установите узел URI.
abstract  UriBuilder matrixParam(java.lang.String name, java.lang.Object... values)
          Добавьте параметр матрицы к существующему набору параметров матрицы текущего заключительного сегмента пути URI.
protected static UriBuilder newInstance()
          Создает новый экземпляр UriBuilder.
abstract  UriBuilder path(java.lang.Class resource)
          Добавьте путь от Аннотируемого путем class до существующего пути.
abstract  UriBuilder path(java.lang.Class resource, java.lang.String method)
          Добавьте путь от метода Path-annotated до существующего пути.
abstract  UriBuilder path(java.lang.reflect.Method method)
          Добавьте путь от a Path- аннотируемый метод к существующему пути.
abstract  UriBuilder path(java.lang.String path)
          Добавьте путь к существующему пути.
abstract  UriBuilder port(int port)
          Установите порт URI.
abstract  UriBuilder queryParam(java.lang.String name, java.lang.Object... values)
          Добавьте параметр запроса к существующему набору параметров запроса.
abstract  UriBuilder replaceMatrix(java.lang.String matrix)
          Установите параметры матрицы текущего заключительного сегмента текущего пути URI.
abstract  UriBuilder replaceMatrixParam(java.lang.String name, java.lang.Object... values)
          Замените существующее значение (я) параметра матрицы на текущем заключительном сегменте пути URI.
abstract  UriBuilder replacePath(java.lang.String path)
          Установите путь URI.
abstract  UriBuilder replaceQuery(java.lang.String query)
          Установите строку запроса URI.
abstract  UriBuilder replaceQueryParam(java.lang.String name, java.lang.Object... values)
          Замените существующее значение (я) параметра запроса.
abstract  UriBuilder scheme(java.lang.String scheme)
          Установите схему URI.
abstract  UriBuilder schemeSpecificPart(java.lang.String ssp)
          Установите специфичную часть схемы URI (см. URI).
abstract  UriBuilder segment(java.lang.String... segments)
          Добавьте сегменты пути к существующему пути.
abstract  UriBuilder uri(java.net.URI uri)
          Копирует ненулевые компоненты предоставленного URI к UriBuilder, заменяющему любые существующие значения для тех компонентов.
abstract  UriBuilder userInfo(java.lang.String ui)
          Установите пользовательскую информацию URI.
 
Методы, наследованные от class java.lang. Объект
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Деталь конструктора

UriBuilder

protected UriBuilder()
Защищенный конструктор, используйте одни из помех fromXXX методы, чтобы получить экземпляр.

Деталь метода

newInstance

protected static UriBuilder newInstance()
Создает новый экземпляр UriBuilder.

Возвраты:
новый экземпляр UriBuilder

fromUri

public static UriBuilder fromUri(java.net.URI uri)
                          throws java.lang.IllegalArgumentException
Создайте новый экземпляр, инициализированный из существующего URI.

Параметры:
uri - URI, который будет использоваться, чтобы инициализировать UriBuilder.
Возвраты:
новый UriBuilder
Броски:
IllegalArgumentException - если туры являются нулем

fromUri

public static UriBuilder fromUri(java.lang.String uri)
                          throws java.lang.IllegalArgumentException
Создайте новый экземпляр, инициализированный из существующего URI.

Параметры:
uri - URI, который будет использоваться, чтобы инициализировать UriBuilder, возможно, не содержит параметры URI.
Возвраты:
новый UriBuilder
Броски:
IllegalArgumentException - если туры не являются допустимым URI или являются нулем

fromPath

public static UriBuilder fromPath(java.lang.String path)
                           throws java.lang.IllegalArgumentException
Создайте новый экземпляр, представляющий относительный URI, инициализированный от пути URI.

Параметры:
path - путь URI, который будет использоваться, чтобы инициализировать UriBuilder, может содержать шаблонные параметры URI.
Возвраты:
новый UriBuilder
Броски:
IllegalArgumentException - если путь является нулем

fromResource

public static UriBuilder fromResource(java.lang.Class<?> resource)
                               throws java.lang.IllegalArgumentException
Создайте новый экземпляр, представляющий относительный URI, инициализированный от корневого ресурса class.

Параметры:
resource - корневой ресурс, чей Path значение будет использоваться, чтобы инициализировать UriBuilder.
Возвраты:
новый UriBuilder
Броски:
IllegalArgumentException - если ресурс не аннотируется Path или ресурс является нулем.

клон

public abstract UriBuilder clone()
Создайте копию UriBuilder, сохраняющего его состояние. Это - больше действенных средств создания копии чем построение нового UriBuilder от URI, возвращенного build(java.lang.Object...) метод.

Переопределения:
clone в class java.lang.Object
Возвраты:
копия UriBuilder

туры

public abstract UriBuilder uri(java.net.URI uri)
                        throws java.lang.IllegalArgumentException
Копирует ненулевые компоненты предоставленного URI к UriBuilder, заменяющему любые существующие значения для тех компонентов.

Параметры:
uri - URI, чтобы скопировать компоненты с
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если туры являются нулем

схема

public abstract UriBuilder scheme(java.lang.String scheme)
                           throws java.lang.IllegalArgumentException
Установите схему URI.

Параметры:
scheme - схема URI, может содержать шаблонные параметры URI. Нулевое значение сбросит схему URI.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если схема недопустима

schemeSpecificPart

public abstract UriBuilder schemeSpecificPart(java.lang.String ssp)
                                       throws java.lang.IllegalArgumentException
Установите специфичную часть схемы URI (см. URI). Этот метод перезапишет любые существующие значения для полномочий, пользовательской информации, узла, порта и пути.

Параметры:
ssp - специфичная часть схемы URI, может содержать шаблонные параметры URI
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если ssp не может быть проанализирован или является нулем

userInfo

public abstract UriBuilder userInfo(java.lang.String ui)
Установите пользовательскую информацию URI.

Параметры:
ui - пользовательская информация URI, может содержать шаблонные параметры URI. Нулевое значение сбросит userInfo компонент URI.
Возвраты:
обновленный UriBuilder

узел

public abstract UriBuilder host(java.lang.String host)
                         throws java.lang.IllegalArgumentException
Установите узел URI.

Параметры:
host - узел URI, может содержать шаблонные параметры URI. Нулевое значение сбросит компонент узла URI.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если узел недопустим.

порт

public abstract UriBuilder port(int port)
                         throws java.lang.IllegalArgumentException
Установите порт URI.

Параметры:
port - порт URI, значение-1 сбросит явный порт.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если порт недопустим

replacePath

public abstract UriBuilder replacePath(java.lang.String path)
Установите путь URI. Этот метод перезапишет любой существующий путь и связанные параметры матрицы. Существующий '/' символы сохраняются таким образом, единственное значение может представить многократные сегменты пути URI.

Параметры:
path - путь, может содержать шаблонные параметры URI. Нулевое значение сбросит компонент пути URI.
Возвраты:
обновленный UriBuilder

путь

public abstract UriBuilder path(java.lang.String path)
                         throws java.lang.IllegalArgumentException
Добавьте путь к существующему пути. Создавая заключительный путь, '/' разделитель будет вставлен между существующим путем и предоставленным путем в случае необходимости. Существующий '/' символы сохраняются таким образом, единственное значение может представить многократные сегменты пути URI.

Параметры:
path - путь, может содержать шаблонные параметры URI
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если путь является нулем

путь

public abstract UriBuilder path(java.lang.Class resource)
                         throws java.lang.IllegalArgumentException
Добавьте путь от Аннотируемого путем class до существующего пути. Создавая заключительный путь, '/' разделитель будет вставлен между существующим путем и предоставленным путем в случае необходимости.

Параметры:
resource - ресурс, чей Path значение будет использоваться, чтобы получить путь, чтобы добавить.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если ресурс является нулем, или если ресурс не аннотируется Path

путь

public abstract UriBuilder path(java.lang.Class resource,
                                java.lang.String method)
                         throws java.lang.IllegalArgumentException
Добавьте путь от метода Path-annotated до существующего пути. Создавая заключительный путь, '/' разделитель будет вставлен между существующим путем и предоставленным путем в случае необходимости. Этот метод является ярлыком удобства на path(Method), это может только использоваться в случаях, где есть единственный метод с указанным именем, которое аннотируется Path.

Параметры:
resource - ресурс, содержащий метод
method - имя метода, чей Path значение будет использоваться, чтобы получить путь, чтобы добавить
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если ресурс или метод являются нулем, или есть больше чем или меньше чем одна разновидность метода, аннотируемого Path

путь

public abstract UriBuilder path(java.lang.reflect.Method method)
                         throws java.lang.IllegalArgumentException
Добавьте путь от a Path- аннотируемый метод к существующему пути. Создавая заключительный путь, '/' разделитель будет вставлен между существующим путем и предоставленным путем в случае необходимости.

Параметры:
method - метод, чей Path значение будет использоваться, чтобы получить путь, чтобы добавить к существующему пути
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если метод является нулем или не аннотируется a Path

сегмент

public abstract UriBuilder segment(java.lang.String... segments)
                            throws java.lang.IllegalArgumentException
Добавьте сегменты пути к существующему пути. Создавая заключительный путь, '/' разделитель будет вставлен между существующим путем и первым сегментом пути в случае необходимости, и каждый предоставленный сегмент будет также разделен '/'. Существующий '/' символы кодируются таким образом, единственное значение может только представить единственный сегмент пути URI.

Параметры:
segments - значения сегмента пути, каждый может содержать шаблонные параметры URI
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если сегменты или какой-либо элемент сегментов являются нулем

replaceMatrix

public abstract UriBuilder replaceMatrix(java.lang.String matrix)
                                  throws java.lang.IllegalArgumentException
Установите параметры матрицы текущего заключительного сегмента текущего пути URI. Этот метод перезапишет любые существующие параметры матрицы на текущем заключительном сегменте текущего пути URI. Отметьте, что параметры матрицы связываются к определенному сегменту пути; последующее добавление сегментов пути не будет влиять на их позицию в пути URI.

Параметры:
matrix - параметры матрицы, может содержать шаблонные параметры URI. Нулевое значение удалит все параметры матрицы текущего заключительного сегмента текущего пути URI.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если матрица не может быть проанализирована
См. Также:
Матричные URI

matrixParam

public abstract UriBuilder matrixParam(java.lang.String name,
                                       java.lang.Object... values)
                                throws java.lang.IllegalArgumentException
Добавьте параметр матрицы к существующему набору параметров матрицы текущего заключительного сегмента пути URI. Если многократные значения будут предоставлены, то параметр будет добавлен однажды на значение. Отметьте, что параметры матрицы связываются к определенному сегменту пути; последующее добавление сегментов пути не будет влиять на их позицию в пути URI.

Параметры:
name - имя параметра матрицы, может содержать шаблонные параметры URI
values - значение (я) параметра матрицы, каждый объект будет преобразован в a String использование toString() метод. Значения Стринджифида могут содержать шаблонные параметры URI.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если имя или значения являются нулем
См. Также:
Матричные URI

replaceMatrixParam

public abstract UriBuilder replaceMatrixParam(java.lang.String name,
                                              java.lang.Object... values)
                                       throws java.lang.IllegalArgumentException
Замените существующее значение (я) параметра матрицы на текущем заключительном сегменте пути URI. Если многократные значения будут предоставлены, то параметр будет добавлен однажды на значение. Отметьте, что параметры матрицы связываются к определенному сегменту пути; последующее добавление сегментов пути не будет влиять на их позицию в пути URI.

Параметры:
name - имя параметра матрицы, может содержать шаблонные параметры URI
values - значение (я) параметра матрицы, каждый объект будет преобразован в a String использование toString() метод. Значения Стринджифида могут содержать шаблонные параметры URI. Если values является пустым или нулевым тогда, вся текущая стоимость параметра удаляется.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если имя является нулем.
См. Также:
Матричные URI

replaceQuery

public abstract UriBuilder replaceQuery(java.lang.String query)
                                 throws java.lang.IllegalArgumentException
Установите строку запроса URI. Этот метод перезапишет любые существующие параметры запроса.

Параметры:
query - строка запроса URI, может содержать шаблонные параметры URI. Нулевое значение удалит все параметры запроса.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если запрос не может быть проанализирован

queryParam

public abstract UriBuilder queryParam(java.lang.String name,
                                      java.lang.Object... values)
                               throws java.lang.IllegalArgumentException
Добавьте параметр запроса к существующему набору параметров запроса. Если многократные значения будут предоставлены, то параметр будет добавлен однажды на значение.

Параметры:
name - имя параметра запроса, может содержать шаблонные параметры URI
values - значение (я) параметра запроса, каждый объект будет преобразован в a String использование toString() метод. Значения Стринджифида могут содержать шаблонные параметры URI.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если имя или значения являются нулем

replaceQueryParam

public abstract UriBuilder replaceQueryParam(java.lang.String name,
                                             java.lang.Object... values)
                                      throws java.lang.IllegalArgumentException
Замените существующее значение (я) параметра запроса. Если многократные значения будут предоставлены, то параметр будет добавлен однажды на значение.

Параметры:
name - имя параметра запроса, может содержать шаблонные параметры URI
values - значение (я) параметра запроса, каждый объект будет преобразован в a String использование toString() метод. Значения Стринджифида могут содержать шаблонные параметры URI. Если values является пустым или нулевым тогда, вся текущая стоимость параметра удаляется.
Возвраты:
обновленный UriBuilder
Броски:
IllegalArgumentException - если имя является нулем

фрагмент

public abstract UriBuilder fragment(java.lang.String fragment)
Установите фрагмент URI.

Параметры:
fragment - фрагмент URI, может содержать шаблонные параметры URI. Нулевое значение удалит любой существующий фрагмент.
Возвраты:
обновленный UriBuilder

buildFromMap

public abstract java.net.URI buildFromMap(java.util.Map<java.lang.String,? extends java.lang.Object> values)
                                   throws java.lang.IllegalArgumentException,
                                          UriBuilderException
Создайте URI, любые шаблонные параметры URI будут заменены значением в предоставленной карте. Значения преобразовываются в String использование их toString метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Все символы '%' в значениях stringified будут закодированы. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика.

Параметры:
values - карта URI обрабатывает по шаблону названия параметра и значения
Возвраты:
URI создается из UriBuilder
Броски:
IllegalArgumentException - если есть какие-либо шаблонные параметры URI без предоставленного значения, или если шаблонное значение параметра является нулем.
UriBuilderException - если URI не может быть создан основанный на текущем состоянии разработчика.

buildFromEncodedMap

public abstract java.net.URI buildFromEncodedMap(java.util.Map<java.lang.String,? extends java.lang.Object> values)
                                          throws java.lang.IllegalArgumentException,
                                                 UriBuilderException
Создайте URI, любые шаблонные параметры URI будут заменены значением в предоставленной карте. Значения преобразовываются в String использование их toString метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Будут закодированы все символы % в значениях stringified, которые не сопровождаются двумя шестнадцатеричными числами. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика.

Параметры:
values - карта URI обрабатывает по шаблону названия параметра и значения
Возвраты:
URI создается из UriBuilder
Броски:
IllegalArgumentException - если есть какие-либо шаблонные параметры URI без предоставленного значения, или если шаблонное значение параметра является нулем.
UriBuilderException - если URI не может быть создан основанный на текущем состоянии разработчика.

создать

public abstract java.net.URI build(java.lang.Object... values)
                            throws java.lang.IllegalArgumentException,
                                   UriBuilderException
Создайте URI, используя предоставленные значения, чтобы заменить любые шаблонные параметры URI. Значения преобразовываются в String использование их toString метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Все символы '%' в значениях stringified будут закодированы. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика.

Все экземпляры того же самого шаблонного параметра будут заменены тем же самым значением, которое соответствует позиции первой инстанции шаблонного параметра. например, шаблон" / {b} /" со значениями {"x", "y", "z"} приведет к URI "x/y/x", не "x/y/z".

Параметры:
values - список URI обрабатывает значения параметра по шаблону
Возвраты:
URI создается из UriBuilder
Броски:
IllegalArgumentException - если есть какие-либо шаблонные параметры URI без предоставленного значения, или если значение является нулем.
UriBuilderException - если URI не может быть создан основанный на текущем состоянии разработчика.

buildFromEncoded

public abstract java.net.URI buildFromEncoded(java.lang.Object... values)
                                       throws java.lang.IllegalArgumentException,
                                              UriBuilderException
Создайте URI. Любые шаблонные параметры URI будут заменены предоставленными значениями в порядке. Значения преобразовываются в String использование их toString метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Будут закодированы все символы % в значениях stringified, которые не сопровождаются двумя шестнадцатеричными числами. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика.

Все экземпляры того же самого шаблонного параметра будут заменены тем же самым значением, которое соответствует позиции первой инстанции шаблонного параметра. например, шаблон" / {b} /" со значениями {"x", "y", "z"} приведет к URI "x/y/x", не "x/y/z".

Параметры:
values - список URI обрабатывает значения параметра по шаблону
Возвраты:
URI создается из UriBuilder
Броски:
IllegalArgumentException - если есть какие-либо шаблонные параметры URI без предоставленного значения, или если значение является нулем.
UriBuilderException - если URI не может быть создан основанный на текущем состоянии разработчика.


Представьте ошибку или функцию

Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается срокам действия лицензии.

Сгенерированный на 10-February-2011 12:41


Spec-Zone.ru - all specs in one place



free hit counter