Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.httpclient.util.URIUtil
public class URIUtil
extends java.lang.Object
HttpURL
rather
than URI
.
Nested Class Summary | |
protected static class |
|
Field Summary | |
protected static BitSet |
Method Summary | |
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
public static String decode(String escaped) throws URIException
Unescape and decode a given string regarded as an escaped string with the default protocol charset.
- Parameters:
escaped
- a string
- Returns:
- the unescaped string
- Throws:
URIException
- if the string cannot be decoded (invalid)
- See Also:
URI.getDefaultProtocolCharset()
public static String decode(String escaped, String charset) throws URIException
Unescape and decode a given string regarded as an escaped string.
- Parameters:
escaped
- a stringcharset
- the charset
- Returns:
- the unescaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
URIUtil.Coder.decode(char[],String)
public static String encode(String unescaped, BitSet allowed) throws URIException
Escape and encode a given string with allowed characters not to be escaped and the default protocol charset.
- Parameters:
unescaped
- a stringallowed
- allowed characters not to be escaped
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
public static String encode(String unescaped, BitSet allowed, String charset) throws URIException
Escape and encode a given string with allowed characters not to be escaped and a given charset.
- Parameters:
unescaped
- a stringallowed
- allowed characters not to be escapedcharset
- the charset
- Returns:
- the escaped string
public static String encodeAll(String unescaped) throws URIException
Get the all escaped and encoded string with the default protocl charset. It's the same function to useencode(String unescaped, Bitset empty, URI.getDefaultProtocolCharset())
.
- Parameters:
unescaped
- an unescaped string
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
,encode
public static String encodeAll(String unescaped, String charset) throws URIException
Get the all escaped and encoded string with a given charset. It's the same function to useencode(String unescaped, Bitset empty, String charset)
.
- Parameters:
unescaped
- an unescaped stringcharset
- the charset
- Returns:
- the escaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
encode
public static String encodePath(String unescaped) throws URIException
Escape and encode a string regarded as the path component of an URI with the default protocol charset.
- Parameters:
unescaped
- an unescaped string
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
,encode
public static String encodePath(String unescaped, String charset) throws URIException
Escape and encode a string regarded as the path component of an URI with a given charset.
- Parameters:
unescaped
- an unescaped stringcharset
- the charset
- Returns:
- the escaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
encode
public static String encodePathQuery(String unescaped) throws URIException
Escape and encode a string regarded as the path and query components of an URI with the default protocol charset.
- Parameters:
unescaped
- an unescaped string
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
,encode
public static String encodePathQuery(String unescaped, String charset) throws URIException
Escape and encode a string regarded as the path and query components of an URI with a given charset.
- Parameters:
unescaped
- an unescaped stringcharset
- the charset
- Returns:
- the escaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
encode
public static String encodeQuery(String unescaped) throws URIException
Escape and encode a string regarded as the query component of an URI with the default protocol charset. When a query string is not misunderstood the reserved special characters ("&", "=", "+", ",", and "$") within a query component, this method is recommended to use in encoding the whole query.
- Parameters:
unescaped
- an unescaped string
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
,encode
public static String encodeQuery(String unescaped, String charset) throws URIException
Escape and encode a string regarded as the query component of an URI with a given charset. When a query string is not misunderstood the reserved special characters ("&", "=", "+", ",", and "$") within a query component, this method is recommended to use in encoding the whole query.
- Parameters:
unescaped
- an unescaped stringcharset
- the charset
- Returns:
- the escaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
encode
public static String encodeWithinAuthority(String unescaped) throws URIException
Escape and encode a string regarded as within the authority component of an URI with the default protocol charset. Within the authority component, the characters ";", ":", "@", "?", and "/" are reserved.
- Parameters:
unescaped
- an unescaped string
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
,encode
public static String encodeWithinAuthority(String unescaped, String charset) throws URIException
Escape and encode a string regarded as within the authority component of an URI with a given charset. Within the authority component, the characters ";", ":", "@", "?", and "/" are reserved.
- Parameters:
unescaped
- an unescaped stringcharset
- the charset
- Returns:
- the escaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
encode
public static String encodeWithinPath(String unescaped) throws URIException
Escape and encode a string regarded as within the path component of an URI with the default protocol charset. The path may consist of a sequence of path segments separated by a single slash "/" character. Within a path segment, the characters "/", ";", "=", and "?" are reserved.
- Parameters:
unescaped
- an unescaped string
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
,encode
public static String encodeWithinPath(String unescaped, String charset) throws URIException
Escape and encode a string regarded as within the path component of an URI with a given charset. The path may consist of a sequence of path segments separated by a single slash "/" character. Within a path segment, the characters "/", ";", "=", and "?" are reserved.
- Parameters:
unescaped
- an unescaped stringcharset
- the charset
- Returns:
- the escaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
encode
public static String encodeWithinQuery(String unescaped) throws URIException
Escape and encode a string regarded as within the query component of an URI with the default protocol charset. When a query comprise the name and value pairs, it is used in order to encode each name and value string. The reserved special characters within a query component are being included in encoding the query.
- Parameters:
unescaped
- an unescaped string
- Returns:
- the escaped string
- Throws:
URIException
- if the default protocol charset is not supported
- See Also:
URI.getDefaultProtocolCharset()
,encode
public static String encodeWithinQuery(String unescaped, String charset) throws URIException
Escape and encode a string regarded as within the query component of an URI with a given charset. When a query comprise the name and value pairs, it is used in order to encode each name and value string. The reserved special characters within a query component are being included in encoding the query.
- Parameters:
unescaped
- an unescaped stringcharset
- the charset
- Returns:
- the escaped string
- Throws:
URIException
- if the charset is not supported
- See Also:
encode
public static String getFromPath(String uri)
Get the path of an URI and its rest part.
- Parameters:
uri
- a string regarded an URI
- Returns:
- the string from the path part
public static String getName(String uri)
Get the basename of an URI. It's possibly an empty string.
- Parameters:
uri
- a string regarded an URI
- Returns:
- the basename string; an empty string if the path ends with slash
public static String getPath(String uri)
Get the path of an URI.
- Parameters:
uri
- a string regarded an URI
- Returns:
- the path string
public static String getPathQuery(String uri)
Get the path and query of an URI.
- Parameters:
uri
- a string regarded an URI
- Returns:
- the path and query string
public static String getQuery(String uri)
Get the query of an URI.
- Parameters:
uri
- a string regarded an URI
- Returns:
- the query string;
null
if empty or undefined