Spec-Zone .ru
спецификации, руководства, описания, API
|
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
java.lang.Object javax.ws.rs.core.UriBuilder
public abstract class UriBuilder
Шаблон URI осведомленная утилита class для создания URI от их компонентов. См. Path.value()
для объяснения шаблонов URI.
Методы разработчика выполняют контекстное кодирование символов, не разрешенных в соответствующем компоненте URI после правил 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 |
Деталь конструктора |
---|
protected UriBuilder()
fromXXX
методы, чтобы получить экземпляр.
Деталь метода |
---|
protected static UriBuilder newInstance()
public static UriBuilder fromUri(java.net.URI uri) throws java.lang.IllegalArgumentException
uri
- URI, который будет использоваться, чтобы инициализировать UriBuilder. IllegalArgumentException
- если туры являются нулемpublic static UriBuilder fromUri(java.lang.String uri) throws java.lang.IllegalArgumentException
uri
- URI, который будет использоваться, чтобы инициализировать UriBuilder, возможно, не содержит параметры URI. IllegalArgumentException
- если туры не являются допустимым URI или являются нулемpublic static UriBuilder fromPath(java.lang.String path) throws java.lang.IllegalArgumentException
path
- путь URI, который будет использоваться, чтобы инициализировать UriBuilder, может содержать шаблонные параметры URI. IllegalArgumentException
- если путь является нулемpublic static UriBuilder fromResource(java.lang.Class<?> resource) throws java.lang.IllegalArgumentException
resource
- корневой ресурс, чей Path
значение будет использоваться, чтобы инициализировать UriBuilder. IllegalArgumentException
- если ресурс не аннотируется Path
или ресурс является нулем.public abstract UriBuilder clone()
build(java.lang.Object...)
метод.
clone
в class java.lang.Object
public abstract UriBuilder uri(java.net.URI uri) throws java.lang.IllegalArgumentException
uri
- URI, чтобы скопировать компоненты с IllegalArgumentException
- если туры являются нулемpublic abstract UriBuilder scheme(java.lang.String scheme) throws java.lang.IllegalArgumentException
scheme
- схема URI, может содержать шаблонные параметры URI. Нулевое значение сбросит схему URI. IllegalArgumentException
- если схема недопустимаpublic abstract UriBuilder schemeSpecificPart(java.lang.String ssp) throws java.lang.IllegalArgumentException
URI
). Этот метод перезапишет любые существующие значения для полномочий, пользовательской информации, узла, порта и пути.
ssp
- специфичная часть схемы URI, может содержать шаблонные параметры URI IllegalArgumentException
- если ssp не может быть проанализирован или является нулемpublic abstract UriBuilder userInfo(java.lang.String ui)
ui
- пользовательская информация URI, может содержать шаблонные параметры URI. Нулевое значение сбросит userInfo компонент URI. public abstract UriBuilder host(java.lang.String host) throws java.lang.IllegalArgumentException
host
- узел URI, может содержать шаблонные параметры URI. Нулевое значение сбросит компонент узла URI. IllegalArgumentException
- если узел недопустим.public abstract UriBuilder port(int port) throws java.lang.IllegalArgumentException
port
- порт URI, значение-1 сбросит явный порт. IllegalArgumentException
- если порт недопустимpublic abstract UriBuilder replacePath(java.lang.String path)
path
- путь, может содержать шаблонные параметры URI. Нулевое значение сбросит компонент пути URI. public abstract UriBuilder path(java.lang.String path) throws java.lang.IllegalArgumentException
path
- путь, может содержать шаблонные параметры URI IllegalArgumentException
- если путь является нулемpublic abstract UriBuilder path(java.lang.Class resource) throws java.lang.IllegalArgumentException
resource
- ресурс, чей Path
значение будет использоваться, чтобы получить путь, чтобы добавить. IllegalArgumentException
- если ресурс является нулем, или если ресурс не аннотируется Path
public abstract UriBuilder path(java.lang.Class resource, java.lang.String method) throws java.lang.IllegalArgumentException
path(Method)
, это может только использоваться в случаях, где есть единственный метод с указанным именем, которое аннотируется Path
.
resource
- ресурс, содержащий методmethod
- имя метода, чей Path
значение будет использоваться, чтобы получить путь, чтобы добавить IllegalArgumentException
- если ресурс или метод являются нулем, или есть больше чем или меньше чем одна разновидность метода, аннотируемого Path
public abstract UriBuilder path(java.lang.reflect.Method method) throws java.lang.IllegalArgumentException
Path
- аннотируемый метод к существующему пути. Создавая заключительный путь, '/' разделитель будет вставлен между существующим путем и предоставленным путем в случае необходимости.
method
- метод, чей Path
значение будет использоваться, чтобы получить путь, чтобы добавить к существующему пути IllegalArgumentException
- если метод является нулем или не аннотируется a Path
public abstract UriBuilder segment(java.lang.String... segments) throws java.lang.IllegalArgumentException
segments
- значения сегмента пути, каждый может содержать шаблонные параметры URI IllegalArgumentException
- если сегменты или какой-либо элемент сегментов являются нулемpublic abstract UriBuilder replaceMatrix(java.lang.String matrix) throws java.lang.IllegalArgumentException
matrix
- параметры матрицы, может содержать шаблонные параметры URI. Нулевое значение удалит все параметры матрицы текущего заключительного сегмента текущего пути URI. IllegalArgumentException
- если матрица не может быть проанализированаpublic abstract UriBuilder matrixParam(java.lang.String name, java.lang.Object... values) throws java.lang.IllegalArgumentException
name
- имя параметра матрицы, может содержать шаблонные параметры URIvalues
- значение (я) параметра матрицы, каждый объект будет преобразован в a String
использование toString()
метод. Значения Стринджифида могут содержать шаблонные параметры URI. IllegalArgumentException
- если имя или значения являются нулемpublic abstract UriBuilder replaceMatrixParam(java.lang.String name, java.lang.Object... values) throws java.lang.IllegalArgumentException
name
- имя параметра матрицы, может содержать шаблонные параметры URIvalues
- значение (я) параметра матрицы, каждый объект будет преобразован в a String
использование toString()
метод. Значения Стринджифида могут содержать шаблонные параметры URI. Если values
является пустым или нулевым тогда, вся текущая стоимость параметра удаляется. IllegalArgumentException
- если имя является нулем.public abstract UriBuilder replaceQuery(java.lang.String query) throws java.lang.IllegalArgumentException
query
- строка запроса URI, может содержать шаблонные параметры URI. Нулевое значение удалит все параметры запроса. IllegalArgumentException
- если запрос не может быть проанализированpublic abstract UriBuilder queryParam(java.lang.String name, java.lang.Object... values) throws java.lang.IllegalArgumentException
name
- имя параметра запроса, может содержать шаблонные параметры URIvalues
- значение (я) параметра запроса, каждый объект будет преобразован в a String
использование toString()
метод. Значения Стринджифида могут содержать шаблонные параметры URI. IllegalArgumentException
- если имя или значения являются нулемpublic abstract UriBuilder replaceQueryParam(java.lang.String name, java.lang.Object... values) throws java.lang.IllegalArgumentException
name
- имя параметра запроса, может содержать шаблонные параметры URIvalues
- значение (я) параметра запроса, каждый объект будет преобразован в a String
использование toString()
метод. Значения Стринджифида могут содержать шаблонные параметры URI. Если values
является пустым или нулевым тогда, вся текущая стоимость параметра удаляется. IllegalArgumentException
- если имя является нулемpublic abstract UriBuilder fragment(java.lang.String fragment)
fragment
- фрагмент URI, может содержать шаблонные параметры URI. Нулевое значение удалит любой существующий фрагмент. public abstract java.net.URI buildFromMap(java.util.Map<java.lang.String,? extends java.lang.Object> values) throws java.lang.IllegalArgumentException, UriBuilderException
String
использование их toString
метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Все символы '%' в значениях stringified будут закодированы. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика.
values
- карта URI обрабатывает по шаблону названия параметра и значения IllegalArgumentException
- если есть какие-либо шаблонные параметры URI без предоставленного значения, или если шаблонное значение параметра является нулем. UriBuilderException
- если URI не может быть создан основанный на текущем состоянии разработчика.public abstract java.net.URI buildFromEncodedMap(java.util.Map<java.lang.String,? extends java.lang.Object> values) throws java.lang.IllegalArgumentException, UriBuilderException
String
использование их toString
метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Будут закодированы все символы % в значениях stringified, которые не сопровождаются двумя шестнадцатеричными числами. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика.
values
- карта URI обрабатывает по шаблону названия параметра и значения IllegalArgumentException
- если есть какие-либо шаблонные параметры URI без предоставленного значения, или если шаблонное значение параметра является нулем. UriBuilderException
- если URI не может быть создан основанный на текущем состоянии разработчика.public abstract java.net.URI build(java.lang.Object... values) throws java.lang.IllegalArgumentException, UriBuilderException
String
использование их toString
метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Все символы '%' в значениях stringified будут закодированы. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика. Все экземпляры того же самого шаблонного параметра будут заменены тем же самым значением, которое соответствует позиции первой инстанции шаблонного параметра. например, шаблон" / {b} /" со значениями {"x", "y", "z"} приведет к URI "x/y/x", не "x/y/z".
values
- список URI обрабатывает значения параметра по шаблону IllegalArgumentException
- если есть какие-либо шаблонные параметры URI без предоставленного значения, или если значение является нулем. UriBuilderException
- если URI не может быть создан основанный на текущем состоянии разработчика.public abstract java.net.URI buildFromEncoded(java.lang.Object... values) throws java.lang.IllegalArgumentException, UriBuilderException
String
использование их toString
метод и тогда кодируется, чтобы соответствовать правила компонента URI, которому они принадлежат. Будут закодированы все символы % в значениях stringified, которые не сопровождаются двумя шестнадцатеричными числами. Состояние разработчика незатронуто; этот метод можно вызвать многократно на том же самом экземпляре разработчика. Все экземпляры того же самого шаблонного параметра будут заменены тем же самым значением, которое соответствует позиции первой инстанции шаблонного параметра. например, шаблон" / {b} /" со значениями {"x", "y", "z"} приведет к URI "x/y/x", не "x/y/z".
values
- список URI обрабатывает значения параметра по шаблону IllegalArgumentException
- если есть какие-либо шаблонные параметры URI без предоставленного значения, или если значение является нулем. UriBuilderException
- если URI не может быть создан основанный на текущем состоянии разработчика.
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается
Сгенерированный на 10-February-2011 12:41