org.aoju.bus.http

Class Url

java.lang.Object

org.aoju.bus.http.Url

public final class Url
extends Object

Paths and Queries should decompose

Neither of the built-in URL models offer direct access to path segments or query parameters. Manually using StringBuilder to assemble these components is cumbersome: do '+' characters get silently replaced with spaces? If a query parameter contains a '&', does that get escaped? By offering methods to read and write individual query parameters directly, application developers are saved from the hassles of encoding and decoding.

The URL (JDK1.0) and URI (Java 1.4) classes predate builders and instead use telescoping constructors. For example, there's no API to compose a URI with a custom port without also providing a query and fragment.

Instances of Url are well-formed and always have a scheme, host, and path. With java.net.URL it's possible to create an awkward URL like http:/ with scheme and path but no hostname. Building APIs that consume such malformed values is difficult!

This class has a modern API. It avoids punitive checked exceptions: get() throws IllegalArgumentException on invalid input or parse() returns null if the input is an invalid URL. You can even be explicit about whether each component has been encoded already.

Since:

JDK 1.8+

Version:

3.6.9

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Url.Builder

Method Summary

Modifier and Type	Method and Description
static String	canonicalize(String input, String encodeSet, boolean alreadyEncoded, boolean strict, boolean plusIsSpace, boolean asciiOnly)
static String	canonicalize(String input, String encodeSet, boolean alreadyEncoded, boolean strict, boolean plusIsSpace, boolean asciiOnly, Charset charset)
static int	defaultPort(String scheme)
String	encodedFragment()
String	encodedPassword()
String	encodedPath()
List<String>	encodedPathSegments()
String	encodedQuery()
String	encodedUsername()
boolean	equals(Object other)
String	fragment()
static Url	get(String url)
static Url	get(URI uri)
static Url	get(URL url)
int	hashCode()
String	host()
boolean	isHttps()
Url.Builder	newBuilder()
Url.Builder	newBuilder(String link)
static Url	parse(String url)
String	password()
List<String>	pathSegments()
int	pathSize()
static void	percentDecode(Buffer out, String encoded, int pos, int limit, boolean plusIsSpace)
static String	percentDecode(String encoded, boolean plusIsSpace)
int	port()
String	query()
String	queryParameter(String name)
String	queryParameterName(int index)
Set<String>	queryParameterNames()
String	queryParameterValue(int index)
List<String>	queryParameterValues(String name)
int	querySize()
String	redact()
Url	resolve(String link)
String	scheme()
String	topPrivateDomain()
String	toString()
URI	uri()
URL	url()
String	username()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

defaultPort

public static int defaultPort(String scheme)

parse

public static Url parse(String url)

get

public static Url get(String url)

get

public static Url get(URL url)

get

public static Url get(URI uri)

percentDecode

public static String percentDecode(String encoded,
                                   boolean plusIsSpace)

percentDecode

public static void percentDecode(Buffer out,
                                 String encoded,
                                 int pos,
                                 int limit,
                                 boolean plusIsSpace)

canonicalize

public static String canonicalize(String input,
                                  String encodeSet,
                                  boolean alreadyEncoded,
                                  boolean strict,
                                  boolean plusIsSpace,
                                  boolean asciiOnly,
                                  Charset charset)

canonicalize

public static String canonicalize(String input,
                                  String encodeSet,
                                  boolean alreadyEncoded,
                                  boolean strict,
                                  boolean plusIsSpace,
                                  boolean asciiOnly)

url

public URL url()

uri

public URI uri()

scheme

public String scheme()

isHttps

public boolean isHttps()

encodedUsername

public String encodedUsername()

username

public String username()

encodedPassword

public String encodedPassword()

password

public String password()

host

public String host()

port

public int port()

pathSize

public int pathSize()

encodedPath

public String encodedPath()

encodedPathSegments

public List<String> encodedPathSegments()

pathSegments

public List<String> pathSegments()

encodedQuery

public String encodedQuery()

query

public String query()

querySize

public int querySize()

queryParameter

public String queryParameter(String name)

queryParameterNames

public Set<String> queryParameterNames()

queryParameterValues

public List<String> queryParameterValues(String name)

queryParameterName

public String queryParameterName(int index)

queryParameterValue

public String queryParameterValue(int index)

encodedFragment

public String encodedFragment()

fragment

public String fragment()

redact

public String redact()

resolve

public Url resolve(String link)

newBuilder

public Url.Builder newBuilder()

newBuilder

public Url.Builder newBuilder(String link)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

topPrivateDomain

public String topPrivateDomain()