UriBuilderImpl (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- javax.ws.rs.core.UriBuilder
- - org.apache.cxf.jaxrs.impl.UriBuilderImpl

All Implemented Interfaces:: Cloneable

public class UriBuilderImpl
extends javax.ws.rs.core.UriBuilder
implements Cloneable

Constructor Summary

Constructors
Constructor and Description

UriBuilderImpl()
Creates builder with empty URI.

UriBuilderImpl(URI uri)
Creates builder initialized with given URI.

Constructors
Constructor and Description
`UriBuilderImpl()` Creates builder with empty URI.
`UriBuilderImpl(URI uri)` Creates builder initialized with given URI.

Method Summary

Methods
Modifier and Type	Method and Description
`URI`	`build(Object... values)`
`URI`	`build(Object[] vars, boolean encodePathSlash)`
`URI`	`buildFromEncoded(Object... values)`
`URI`	`buildFromEncodedMap(Map<String,?> map)`
`URI`	`buildFromMap(Map<String,?> map)`
`URI`	`buildFromMap(Map<String,?> map, boolean encodePathSlash)`
`javax.ws.rs.core.UriBuilder`	`clone()`
`javax.ws.rs.core.UriBuilder`	`fragment(String theFragment)`
`javax.ws.rs.core.UriBuilder`	`host(String theHost)`
`javax.ws.rs.core.UriBuilder`	`matrixParam(String name, Object... values)`
`javax.ws.rs.core.UriBuilder`	`path(Class resource)`
`javax.ws.rs.core.UriBuilder`	`path(Class resource, String method)`
`javax.ws.rs.core.UriBuilder`	`path(Method method)`
`javax.ws.rs.core.UriBuilder`	`path(String path)`
`javax.ws.rs.core.UriBuilder`	`port(int thePort)`
`javax.ws.rs.core.UriBuilder`	`queryParam(String name, Object... values)`
`javax.ws.rs.core.UriBuilder`	`replaceMatrix(String matrixValues)`
`javax.ws.rs.core.UriBuilder`	`replaceMatrixParam(String name, Object... values)`
`javax.ws.rs.core.UriBuilder`	`replacePath(String path)`
`javax.ws.rs.core.UriBuilder`	`replaceQuery(String queryValue)`
`javax.ws.rs.core.UriBuilder`	`replaceQueryParam(String name, Object... values)`
`javax.ws.rs.core.UriBuilder`	`resolveTemplate(String name, Object value)`
`javax.ws.rs.core.UriBuilder`	`resolveTemplate(String name, Object value, boolean encodePathSlash)`
`javax.ws.rs.core.UriBuilder`	`resolveTemplateFromEncoded(String name, Object value)`
`javax.ws.rs.core.UriBuilder`	`resolveTemplates(Map<String,Object> values)`
`javax.ws.rs.core.UriBuilder`	`resolveTemplates(Map<String,Object> values, boolean encodePathSlash)`
`javax.ws.rs.core.UriBuilder`	`resolveTemplatesFromEncoded(Map<String,Object> values)`
`javax.ws.rs.core.UriBuilder`	`scheme(String s)`
`javax.ws.rs.core.UriBuilder`	`schemeSpecificPart(String ssp)`
`javax.ws.rs.core.UriBuilder`	`segment(String... segments)`
`String`	`toTemplate()`
`javax.ws.rs.core.UriBuilder`	`uri(String uriTemplate)`
`javax.ws.rs.core.UriBuilder`	`uri(URI uri)`
`javax.ws.rs.core.UriBuilder`	`uriAsTemplate(String uri)`
`javax.ws.rs.core.UriBuilder`	`userInfo(String ui)`

Methods inherited from class javax.ws.rs.core.UriBuilder
fromLink, fromMethod, fromPath, fromResource, fromUri, fromUri, newInstance

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- UriBuilderImpl
```
public UriBuilderImpl()
```
  Creates builder with empty URI.
- UriBuilderImpl
```
public UriBuilderImpl(URI uri)
               throws IllegalArgumentException
```
  Creates builder initialized with given URI.
  
  Parameters:
  uri - initial value for builder
  
  Throws:
  
  IllegalArgumentException - when uri is null

Method Detail

build

public URI build(Object... values)
          throws IllegalArgumentException,
                 javax.ws.rs.core.UriBuilderException

Specified by:: build in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException; javax.ws.rs.core.UriBuilderException

buildFromEncoded

public URI buildFromEncoded(Object... values)
                     throws IllegalArgumentException,
                            javax.ws.rs.core.UriBuilderException

Specified by:: buildFromEncoded in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException; javax.ws.rs.core.UriBuilderException

buildFromMap

public URI buildFromMap(Map<String,?> map)
                 throws IllegalArgumentException,
                        javax.ws.rs.core.UriBuilderException

Specified by:: buildFromMap in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException; javax.ws.rs.core.UriBuilderException

buildFromEncodedMap

public URI buildFromEncodedMap(Map<String,?> map)
                        throws IllegalArgumentException,
                               javax.ws.rs.core.UriBuilderException

Specified by:: buildFromEncodedMap in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException; javax.ws.rs.core.UriBuilderException

clone
```
public javax.ws.rs.core.UriBuilder clone()
```
Overrides:

clone in class javax.ws.rs.core.UriBuilder

fragment

public javax.ws.rs.core.UriBuilder fragment(String theFragment)
                                     throws IllegalArgumentException

Specified by:: fragment in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

host

public javax.ws.rs.core.UriBuilder host(String theHost)
                                 throws IllegalArgumentException

Specified by:: host in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

path

public javax.ws.rs.core.UriBuilder path(Class resource)
                                 throws IllegalArgumentException

Specified by:: path in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

path

public javax.ws.rs.core.UriBuilder path(Class resource,
                               String method)
                                 throws IllegalArgumentException

Specified by:: path in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

path

public javax.ws.rs.core.UriBuilder path(Method method)
                                 throws IllegalArgumentException

Specified by:: path in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

path

public javax.ws.rs.core.UriBuilder path(String path)
                                 throws IllegalArgumentException

Specified by:: path in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

port

public javax.ws.rs.core.UriBuilder port(int thePort)
                                 throws IllegalArgumentException

Specified by:: port in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

scheme

public javax.ws.rs.core.UriBuilder scheme(String s)
                                   throws IllegalArgumentException

Specified by:: scheme in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

schemeSpecificPart

public javax.ws.rs.core.UriBuilder schemeSpecificPart(String ssp)
                                               throws IllegalArgumentException

Specified by:: schemeSpecificPart in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

uri

public javax.ws.rs.core.UriBuilder uri(URI uri)
                                throws IllegalArgumentException

Specified by:: uri in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

userInfo

public javax.ws.rs.core.UriBuilder userInfo(String ui)
                                     throws IllegalArgumentException

Specified by:: userInfo in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

matrixParam

public javax.ws.rs.core.UriBuilder matrixParam(String name,
                                      Object... values)
                                        throws IllegalArgumentException

Specified by:: matrixParam in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

queryParam

public javax.ws.rs.core.UriBuilder queryParam(String name,
                                     Object... values)
                                       throws IllegalArgumentException

Specified by:: queryParam in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

replaceMatrix

public javax.ws.rs.core.UriBuilder replaceMatrix(String matrixValues)
                                          throws IllegalArgumentException

Specified by:: replaceMatrix in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

replaceMatrixParam

public javax.ws.rs.core.UriBuilder replaceMatrixParam(String name,
                                             Object... values)
                                               throws IllegalArgumentException

Specified by:: replaceMatrixParam in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

replacePath
```
public javax.ws.rs.core.UriBuilder replacePath(String path)
```
Specified by:

replacePath in class javax.ws.rs.core.UriBuilder

replaceQuery

public javax.ws.rs.core.UriBuilder replaceQuery(String queryValue)
                                         throws IllegalArgumentException

Specified by:: replaceQuery in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

replaceQueryParam

public javax.ws.rs.core.UriBuilder replaceQueryParam(String name,
                                            Object... values)
                                              throws IllegalArgumentException

Specified by:: replaceQueryParam in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

segment

public javax.ws.rs.core.UriBuilder segment(String... segments)
                                    throws IllegalArgumentException

Specified by:: segment in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

uri

public javax.ws.rs.core.UriBuilder uri(String uriTemplate)
                                throws IllegalArgumentException

Specified by:: uri in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

uriAsTemplate

public javax.ws.rs.core.UriBuilder uriAsTemplate(String uri)

build

public URI build(Object[] vars,
        boolean encodePathSlash)
          throws IllegalArgumentException,
                 javax.ws.rs.core.UriBuilderException

Specified by:: build in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException; javax.ws.rs.core.UriBuilderException

buildFromMap

public URI buildFromMap(Map<String,?> map,
               boolean encodePathSlash)
                 throws IllegalArgumentException,
                        javax.ws.rs.core.UriBuilderException

Specified by:: buildFromMap in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException; javax.ws.rs.core.UriBuilderException

toTemplate
```
public String toTemplate()
```
Specified by:

toTemplate in class javax.ws.rs.core.UriBuilder

resolveTemplate

public javax.ws.rs.core.UriBuilder resolveTemplate(String name,
                                          Object value)
                                            throws IllegalArgumentException

Specified by:: resolveTemplate in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

resolveTemplate

public javax.ws.rs.core.UriBuilder resolveTemplate(String name,
                                          Object value,
                                          boolean encodePathSlash)
                                            throws IllegalArgumentException

Specified by:: resolveTemplate in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

resolveTemplates

public javax.ws.rs.core.UriBuilder resolveTemplates(Map<String,Object> values)
                                             throws IllegalArgumentException

Specified by:: resolveTemplates in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

resolveTemplates

public javax.ws.rs.core.UriBuilder resolveTemplates(Map<String,Object> values,
                                           boolean encodePathSlash)
                                             throws IllegalArgumentException

Specified by:: resolveTemplates in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

resolveTemplateFromEncoded

public javax.ws.rs.core.UriBuilder resolveTemplateFromEncoded(String name,
                                                     Object value)
                                                       throws IllegalArgumentException

Specified by:: resolveTemplateFromEncoded in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

resolveTemplatesFromEncoded

public javax.ws.rs.core.UriBuilder resolveTemplatesFromEncoded(Map<String,Object> values)
                                                        throws IllegalArgumentException

Specified by:: resolveTemplatesFromEncoded in class javax.ws.rs.core.UriBuilder
Throws:: IllegalArgumentException

Class UriBuilderImpl

Constructor Summary

Method Summary

Methods inherited from class javax.ws.rs.core.UriBuilder

Methods inherited from class java.lang.Object

Constructor Detail

UriBuilderImpl

UriBuilderImpl

Method Detail

build

buildFromEncoded

buildFromMap

buildFromEncodedMap

clone

fragment

host

path

path

path

path

port

scheme

schemeSpecificPart

uri

userInfo

matrixParam

queryParam

replaceMatrix

replaceMatrixParam

replacePath

replaceQuery

replaceQueryParam

segment

uri

uriAsTemplate

build

buildFromMap

toTemplate

resolveTemplate

resolveTemplate

resolveTemplates

resolveTemplates

resolveTemplateFromEncoded

resolveTemplatesFromEncoded