|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.ws.rs.core.UriBuilder
org.restlet.ext.jaxrs.AbstractUriBuilder
public abstract class AbstractUriBuilder
Abstract implementation of interface UriBuilder
. Not intended for
public use.
UriBuilder
Constructor Summary | |
---|---|
protected |
AbstractUriBuilder()
|
Method Summary | |
---|---|
URI |
build(Object... values)
Build a URI, using the supplied values in order to replace any URI template parameters. |
URI |
buildFromEncoded(Object... values)
|
URI |
buildFromEncodedMap(Map<String,? extends Object> values)
|
URI |
buildFromMap(Map<String,? extends Object> values)
|
protected void |
copyInto(AbstractUriBuilder uriBuilder)
|
javax.ws.rs.core.UriBuilder |
fragment(String fragment)
Set the URI fragment using an unencoded value. |
protected String |
getExtension()
|
javax.ws.rs.core.UriBuilder |
host(String host)
Set the URI host. |
javax.ws.rs.core.UriBuilder |
matrixParam(String name,
Object... values)
Append a matrix parameter to the existing set of matrix parameters of the current final segment of the URI path. |
protected javax.ws.rs.core.UriBuilder |
path(CharSequence pathToAppend)
Appends the given path to the current path.S |
javax.ws.rs.core.UriBuilder |
path(Class rootResource)
Append path segments from a Path-annotated class to the existing list of segments. |
javax.ws.rs.core.UriBuilder |
path(Class rootResource,
String methodName)
Append path segments from a Path-annotated method to the existing list of segments. |
javax.ws.rs.core.UriBuilder |
path(Method method)
Append the path from a Path -annotated method to the
existing path. |
javax.ws.rs.core.UriBuilder |
path(String pathToAppend)
Append path to the existing path. |
javax.ws.rs.core.UriBuilder |
port(int port)
Set the URI port. |
javax.ws.rs.core.UriBuilder |
port(String port)
Set the URI port. |
javax.ws.rs.core.UriBuilder |
queryParam(String name,
Object... values)
Append a query parameter to the existing set of query parameters. |
javax.ws.rs.core.UriBuilder |
replaceMatrix(String matrix)
Set the matrix parameters of the current final segment of the current URI path. |
javax.ws.rs.core.UriBuilder |
replaceMatrixParam(String name,
Object... values)
|
protected javax.ws.rs.core.UriBuilder |
replacePath(CharSequence newPath)
Replaces the current path with the given path. |
javax.ws.rs.core.UriBuilder |
replacePath(String newPath)
Set the URI path. |
javax.ws.rs.core.UriBuilder |
replaceQuery(String query)
Set the URI query string. |
javax.ws.rs.core.UriBuilder |
replaceQueryParam(String name,
Object... values)
|
javax.ws.rs.core.UriBuilder |
scheme(String scheme)
Set the URI scheme. |
javax.ws.rs.core.UriBuilder |
schemeSpecificPart(String ssp)
Set the URI scheme-specific-part (see URI ). |
javax.ws.rs.core.UriBuilder |
segment(String... segments)
Append path segments to the existing path. |
String |
toString()
Returns the actual URI as String. |
javax.ws.rs.core.UriBuilder |
uri(URI uri)
Copies the non-null components of the supplied URI to the UriBuilder replacing any existing values for those components. |
javax.ws.rs.core.UriBuilder |
userInfo(String userInfo)
Set the URI user-info. |
Methods inherited from class javax.ws.rs.core.UriBuilder |
---|
clone, fromPath, fromResource, fromUri, fromUri, newInstance |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected AbstractUriBuilder()
Method Detail |
---|
public URI build(Object... values) throws IllegalArgumentException, javax.ws.rs.core.UriBuilderException
String
using
their toString
method and are then encoded to match the
rules of the URI component to which they pertain. All '%' characters in
the stringified values will be encoded. The state of the builder is
unaffected; this method may be called multiple times on the same builder
instance.
All instances of the same template parameter will be replaced by the same value that corresponds to the position of the first instance of the template parameter. e.g. the template "{a}/{b}/{a}" with values {"x", "y", "z"} will result in the the URI "x/y/x", not "x/y/z".
build
in class javax.ws.rs.core.UriBuilder
values
- a list of URI template parameter values
IllegalArgumentException
- if there are any URI template parameters without a supplied
value, or if a value is null.
javax.ws.rs.core.UriBuilderException
- if a URI cannot be constructed based on the current state of
the builder.UriBuilder.build(java.lang.Object[])
public URI buildFromEncoded(Object... values) throws IllegalArgumentException, javax.ws.rs.core.UriBuilderException
buildFromEncoded
in class javax.ws.rs.core.UriBuilder
IllegalArgumentException
javax.ws.rs.core.UriBuilderException
UriBuilder.buildFromEncoded(java.lang.Object[])
public URI buildFromEncodedMap(Map<String,? extends Object> values) throws IllegalArgumentException, javax.ws.rs.core.UriBuilderException
buildFromEncodedMap
in class javax.ws.rs.core.UriBuilder
IllegalArgumentException
javax.ws.rs.core.UriBuilderException
UriBuilder.buildFromEncodedMap(java.util.Map)
public URI buildFromMap(Map<String,? extends Object> values) throws IllegalArgumentException, javax.ws.rs.core.UriBuilderException
buildFromMap
in class javax.ws.rs.core.UriBuilder
IllegalArgumentException
javax.ws.rs.core.UriBuilderException
UriBuilder.buildFromMap(java.util.Map)
protected void copyInto(AbstractUriBuilder uriBuilder)
uriBuilder
- public javax.ws.rs.core.UriBuilder fragment(String fragment) throws IllegalArgumentException
fragment
in class javax.ws.rs.core.UriBuilder
fragment
- the URI fragment, may contain URI template parameters
IllegalArgumentException
- if fragment is null, or if automatic encoding is disabled and
fragment contains illegal charactersUriBuilder.fragment(java.lang.String)
protected String getExtension()
public javax.ws.rs.core.UriBuilder host(String host) throws IllegalArgumentException
host
in class javax.ws.rs.core.UriBuilder
host
- the URI host, may contain URI template parameters
IllegalArgumentException
- if host is invalid or is nullUriBuilder.host(java.lang.String)
public javax.ws.rs.core.UriBuilder matrixParam(String name, Object... values) throws IllegalArgumentException
matrixParam
in class javax.ws.rs.core.UriBuilder
name
- the matrix parameter name, may contain URI template parametersvalues
- the matrix parameter value(s), each object will be converted
to a String
using its toString()
method.
Stringified values may contain URI template parameters.
IllegalArgumentException
- if name or value is null, or if automatic encoding is
disabled and the name or any stringified value contains
illegal charactersUriBuilder.matrixParam(String, Object...)
protected javax.ws.rs.core.UriBuilder path(CharSequence pathToAppend) throws IllegalArgumentException
pathToAppend
-
IllegalArgumentException
public javax.ws.rs.core.UriBuilder path(Class rootResource) throws IllegalArgumentException
Path
but it will not be used to modify the state of
automatic encoding for the builder.
path
in class javax.ws.rs.core.UriBuilder
rootResource
- a resource whose @Path value will be used to obtain the
path segment.
IllegalArgumentException
- if resource is null, or if resource.encode is false and
resource.value contains illegal characters, or if resource is
not annotated with UrPathUriBuilder.path(java.lang.Class)
public javax.ws.rs.core.UriBuilder path(Class rootResource, String methodName) throws IllegalArgumentException
path(Method)
, it can only be used in cases where there is a
single method with the specified name that is annotated with @
Path
.
path
in class javax.ws.rs.core.UriBuilder
rootResource
- the root resource class containing the method.methodName
- the name of the method whose @Path
value will be
used to obtain the path segment.
IllegalArgumentException
- if resource or method is null, or if the specified method
does not exist, or there is more than or less than one
variant of the method annotated with UriPathUriBuilder.path(java.lang.Class, java.lang.String)
public javax.ws.rs.core.UriBuilder path(Method method) throws IllegalArgumentException
Path
-annotated method to the
existing path. When constructing the final path, a '/' separator will be
inserted between the existing path and the supplied path if necessary.
path
in class javax.ws.rs.core.UriBuilder
method
- a method whose Path
value will be used to
obtain the path to append to the existing path
IllegalArgumentException
- if any element of methods is null or is not annotated with a
Path
UriBuilder.path(java.lang.reflect.Method)
public javax.ws.rs.core.UriBuilder path(String pathToAppend) throws IllegalArgumentException
path
in class javax.ws.rs.core.UriBuilder
pathToAppend
- the path to append to the current path, may contain URI
template parameters
IllegalArgumentException
- if path is nullUriBuilder.path(java.lang.String)
public javax.ws.rs.core.UriBuilder port(int port) throws IllegalArgumentException
port
in class javax.ws.rs.core.UriBuilder
port
- the URI port, a value of -1 will unset an explicit port.
IllegalArgumentException
- if port is invalidUriBuilder.port(int)
public javax.ws.rs.core.UriBuilder port(String port) throws IllegalArgumentException
port
- the URI port (null will unset an explicit port) or a template
variable.
IllegalArgumentException
- if given value is invalidport(int)
public javax.ws.rs.core.UriBuilder queryParam(String name, Object... values) throws IllegalArgumentException
queryParam
in class javax.ws.rs.core.UriBuilder
name
- the query parameter name, may contain URI template parametersvalues
- the query parameter value(s), each object will be converted to
a String
using its toString()
method.
Stringified values may contain URI template parameters.
IllegalArgumentException
- if name or value is null, or if automatic encoding is
disabled and name or value contains illegal charactersUriBuilder.queryParam(String, Object...)
public javax.ws.rs.core.UriBuilder replaceMatrix(String matrix) throws IllegalArgumentException
replaceMatrix
in class javax.ws.rs.core.UriBuilder
matrix
- the matrix parameters, may contain URI template parameters. A
null value will remove all matrix parameters of the current
final segment of the current URI path.
IllegalArgumentException
- if matrix cannot be parsed, or if automatic encoding is
disabled and any matrix parameter name or value contains
illegal charactersUriBuilder.replaceMatrix(String)
public javax.ws.rs.core.UriBuilder replaceMatrixParam(String name, Object... values) throws IllegalArgumentException
replaceMatrixParam
in class javax.ws.rs.core.UriBuilder
IllegalArgumentException
UriBuilder.replaceMatrixParam(java.lang.String,
java.lang.Object[])
protected javax.ws.rs.core.UriBuilder replacePath(CharSequence newPath) throws IllegalArgumentException
newPath
- the new path.
IllegalArgumentException
public javax.ws.rs.core.UriBuilder replacePath(String newPath) throws IllegalArgumentException
replacePath
in class javax.ws.rs.core.UriBuilder
newPath
- the path to replace the old path with, may contain URI
template parameters. A null value will unset the path
component of the URI.
IllegalArgumentException
UriBuilder.replacePath(java.lang.String)
public javax.ws.rs.core.UriBuilder replaceQuery(String query) throws IllegalArgumentException
replaceQuery
in class javax.ws.rs.core.UriBuilder
query
- the URI query string, may contain URI template parameters. A
null value will remove all query parameters.
IllegalArgumentException
- if query cannot be parsedUriBuilder.replaceQuery(java.lang.String)
public javax.ws.rs.core.UriBuilder replaceQueryParam(String name, Object... values) throws IllegalArgumentException
replaceQueryParam
in class javax.ws.rs.core.UriBuilder
IllegalArgumentException
UriBuilder.replaceQueryParam(String, Object[])
public javax.ws.rs.core.UriBuilder scheme(String scheme) throws IllegalArgumentException
scheme
in class javax.ws.rs.core.UriBuilder
scheme
- the URI scheme, may contain URI template parameters
IllegalArgumentException
- if scheme is invalid or is nullUriBuilder.scheme(java.lang.String)
public javax.ws.rs.core.UriBuilder schemeSpecificPart(String ssp) throws IllegalArgumentException
URI
). This method
will overwrite any existing values for authority, user-info, host, port
and path.
schemeSpecificPart
in class javax.ws.rs.core.UriBuilder
ssp
- the URI scheme-specific-part, may contain URI template
parameters
IllegalArgumentException
- if ssp cannot be parsed or is nullUriBuilder.schemeSpecificPart(java.lang.String)
public javax.ws.rs.core.UriBuilder segment(String... segments) throws IllegalArgumentException
segment
in class javax.ws.rs.core.UriBuilder
segments
- the path segment values, each may contain URI template
parameters
IllegalArgumentException
- if segments or any element of segments is nullUriBuilder.segment(java.lang.String[])
public String toString()
toString
in class Object
toStringWithCheck(boolean)
public javax.ws.rs.core.UriBuilder uri(URI uri) throws IllegalArgumentException
uri
in class javax.ws.rs.core.UriBuilder
uri
- the URI to copy components from
IllegalArgumentException
- if uri is nullUriBuilder.uri(java.net.URI)
public javax.ws.rs.core.UriBuilder userInfo(String userInfo) throws IllegalArgumentException
userInfo
in class javax.ws.rs.core.UriBuilder
userInfo
- the URI user-info, may contain URI template parameters
IllegalArgumentException
- if automatic encoding is disabled and the userInfo contains
illegal characters, or if the userInfo is null.UriBuilder.userInfo(java.lang.String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |