Module swim.uri

Package swim.uri

Class Uri

java.lang.Object

swim.uri.Uri

All Implemented Interfaces:

Comparable<Uri>, swim.codec.Debug, swim.codec.Display

public class Uri
extends Object
implements Comparable<Uri>, swim.codec.Debug, swim.codec.Display

Field Summary

Fields

Modifier and Type	Field	Description
protected UriAuthority	authority
protected UriFragment	fragment
protected UriPath	path
protected UriQuery	query
protected UriScheme	scheme

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Uri(UriScheme scheme, UriAuthority authority, UriPath path, UriQuery query, UriFragment fragment)

Method Summary

Modifier and Type	Method	Description
Uri	appendedPath(String component)
Uri	appendedPath(String... components)
Uri	appendedPath(Collection<? extends String> components)
Uri	appendedQuery(String value)
Uri	appendedQuery(String... keyValuePairs)
Uri	appendedQuery(String key, String value)
Uri	appendedQuery(Map<? extends String,? extends String> params)
Uri	appendedSegment(String segment)
Uri	appendedSlash()
UriAuthority	authority()
Uri	authority(UriAuthority authority)
String	authorityPart()
Uri	authorityPart(String authority)
Uri	base()
UriPath	basePath()
Uri	body()
UriPath	bodyPath()
int	compareTo(Uri that)
protected Uri	copy(UriScheme scheme, UriAuthority authority, UriPath path, UriQuery query, UriFragment fragment)
static Uri	create(UriPart part)
static Uri	create(UriPath path)
static Uri	create(UriPath path, UriFragment fragment)
static Uri	create(UriPath path, UriQuery query)
static Uri	create(UriPath path, UriQuery query, UriFragment fragment)
static Uri	create(UriScheme scheme, UriAuthority authority)
static Uri	create(UriScheme scheme, UriAuthority authority, UriPath path)
static Uri	create(UriScheme scheme, UriAuthority authority, UriPath path, UriFragment fragment)
static Uri	create(UriScheme scheme, UriAuthority authority, UriPath path, UriQuery query)
static Uri	create(UriScheme scheme, UriAuthority authority, UriPath path, UriQuery query, UriFragment fragment)
<T> swim.codec.Output<T>	debug(swim.codec.Output<T> output)
<T> swim.codec.Output<T>	display(swim.codec.Output<T> output)
static Uri	empty()
Uri	endpoint()
boolean	equals(Object other)
static swim.structure.Form<Uri>	form()
UriFragment	fragment()
Uri	fragment(UriFragment fragment)
String	fragmentIdentifier()
Uri	fragmentIdentifier(String fragment)
String	fragmentPart()
Uri	fragmentPart(String fragment)
int	hashCode()
UriHost	host()
Uri	host(UriHost host)
String	hostAddress()
String	hostIPv4()
Uri	hostIPv4(String address)
String	hostIPv6()
Uri	hostIPv6(String address)
String	hostName()
Uri	hostName(String address)
String	hostPart()
Uri	hostPart(String host)
boolean	isChildOf(Uri absolute)
boolean	isDefined()
boolean	isEmpty()
boolean	isRelativeTo(Uri absolute)
protected UriPath	merge(UriPath relative)
Uri	parent()
UriPath	parentPath()
static Uri	parse(String string)
String	password()
Uri	password(String password)
UriPath	path()
Uri	path(String... components)
Uri	path(UriPath path)
String	pathName()
Uri	pathName(String name)
String	pathPart()
Uri	pathPart(String path)
UriPort	port()
Uri	port(UriPort port)
int	portNumber()
Uri	portNumber(int number)
String	portPart()
Uri	portPart(String port)
Uri	prependedPath(String component)
Uri	prependedPath(String... components)
Uri	prependedPath(Collection<? extends String> components)
Uri	prependedQuery(String value)
Uri	prependedQuery(String... keyValuePairs)
Uri	prependedQuery(String key, String value)
Uri	prependedQuery(Map<? extends String,? extends String> params)
Uri	prependedSegment(String segment)
Uri	prependedSlash()
UriQuery	query()
Uri	query(String... keyValuePairs)
Uri	query(UriQuery query)
String	queryPart()
Uri	queryPart(String query)
Uri	removedQuery(String key)
Uri	resolve(Uri relative)
UriScheme	scheme()
Uri	scheme(UriScheme scheme)
String	schemeName()
Uri	schemeName(String scheme)
String	schemePart()
Uri	schemePart(String scheme)
static UriParser	standardParser()
String	toString()
Uri	unresolve(Uri absolute)
Uri	updatedQuery(String key, String value)
UriUser	user()
Uri	user(UriUser user)
String	username()
Uri	username(String username)
Uri	username(String username, String password)
String	userPart()
Uri	userPart(String user)

Methods inherited from class java.lang.Object

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

Field Detail

scheme

protected final UriScheme scheme

authority

protected final UriAuthority authority

path

protected final UriPath path

query

protected final UriQuery query

fragment

protected final UriFragment fragment

Constructor Detail

Uri

protected Uri(UriScheme scheme,
              UriAuthority authority,
              UriPath path,
              UriQuery query,
              UriFragment fragment)

Method Detail

isDefined

public final boolean isDefined()

isEmpty

public final boolean isEmpty()

scheme

public final UriScheme scheme()

scheme

public Uri scheme(UriScheme scheme)

schemePart

public final String schemePart()

schemePart

public Uri schemePart(String scheme)

schemeName

public final String schemeName()

schemeName

public Uri schemeName(String scheme)

authority

public final UriAuthority authority()

authority

public Uri authority(UriAuthority authority)

authorityPart

public final String authorityPart()

authorityPart

public Uri authorityPart(String authority)

user

public final UriUser user()

user

public Uri user(UriUser user)

userPart

public final String userPart()

userPart

public Uri userPart(String user)

username

public String username()

username

public Uri username(String username)

username

public Uri username(String username,
                    String password)

password

public String password()

password

public Uri password(String password)

host

public final UriHost host()

host

public Uri host(UriHost host)

hostPart

public final String hostPart()

hostPart

public Uri hostPart(String host)

hostAddress

public final String hostAddress()

hostName

public final String hostName()

hostName

public Uri hostName(String address)

hostIPv4

public final String hostIPv4()

hostIPv4

public Uri hostIPv4(String address)

hostIPv6

public final String hostIPv6()

hostIPv6

public Uri hostIPv6(String address)

port

public final UriPort port()

port

public Uri port(UriPort port)

portPart

public final String portPart()

portPart

public Uri portPart(String port)

portNumber

public final int portNumber()

portNumber

public Uri portNumber(int number)

path

public final UriPath path()

path

public Uri path(UriPath path)

path

public Uri path(String... components)

pathPart

public final String pathPart()

pathPart

public Uri pathPart(String path)

pathName

public final String pathName()

pathName

public Uri pathName(String name)

parentPath

public final UriPath parentPath()

basePath

public final UriPath basePath()

bodyPath

public final UriPath bodyPath()

parent

public final Uri parent()

base

public final Uri base()

body

public final Uri body()

appendedPath

public Uri appendedPath(String component)

appendedPath

public Uri appendedPath(String... components)

appendedPath

public Uri appendedPath(Collection<? extends String> components)

appendedSlash

public Uri appendedSlash()

appendedSegment

public Uri appendedSegment(String segment)

prependedPath

public Uri prependedPath(String component)

prependedPath

public Uri prependedPath(String... components)

prependedPath

public Uri prependedPath(Collection<? extends String> components)

prependedSlash

public Uri prependedSlash()

prependedSegment

public Uri prependedSegment(String segment)

query

public final UriQuery query()

query

public Uri query(UriQuery query)

query

public Uri query(String... keyValuePairs)

queryPart

public final String queryPart()

queryPart

public Uri queryPart(String query)

updatedQuery

public Uri updatedQuery(String key,
                        String value)

removedQuery

public Uri removedQuery(String key)

appendedQuery

public Uri appendedQuery(String value)

appendedQuery

public Uri appendedQuery(String key,
                         String value)

appendedQuery

public Uri appendedQuery(String... keyValuePairs)

appendedQuery

public Uri appendedQuery(Map<? extends String,? extends String> params)

prependedQuery

public Uri prependedQuery(String value)

prependedQuery

public Uri prependedQuery(String key,
                          String value)

prependedQuery

public Uri prependedQuery(String... keyValuePairs)

prependedQuery

public Uri prependedQuery(Map<? extends String,? extends String> params)

fragment

public final UriFragment fragment()

fragment

public Uri fragment(UriFragment fragment)

fragmentPart

public final String fragmentPart()

fragmentPart

public Uri fragmentPart(String fragment)

fragmentIdentifier

public final String fragmentIdentifier()

fragmentIdentifier

public Uri fragmentIdentifier(String fragment)

endpoint

public Uri endpoint()

isRelativeTo

public boolean isRelativeTo(Uri absolute)

isChildOf

public boolean isChildOf(Uri absolute)

resolve

public Uri resolve(Uri relative)

merge

protected UriPath merge(UriPath relative)

unresolve

public Uri unresolve(Uri absolute)

copy

protected Uri copy(UriScheme scheme,
                   UriAuthority authority,
                   UriPath path,
                   UriQuery query,
                   UriFragment fragment)

compareTo

public final int compareTo(Uri that)

Specified by:

compareTo in interface Comparable<Uri>

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

debug

public <T> swim.codec.Output<T> debug(swim.codec.Output<T> output)

Specified by:

debug in interface swim.codec.Debug

display

public <T> swim.codec.Output<T> display(swim.codec.Output<T> output)

Specified by:

display in interface swim.codec.Display

toString

public final String toString()

Overrides:

toString in class Object

empty

public static Uri empty()

create

public static Uri create(UriScheme scheme,
                         UriAuthority authority,
                         UriPath path,
                         UriQuery query,
                         UriFragment fragment)

create

public static Uri create(UriScheme scheme,
                         UriAuthority authority,
                         UriPath path,
                         UriQuery query)

create

public static Uri create(UriScheme scheme,
                         UriAuthority authority,
                         UriPath path,
                         UriFragment fragment)

create

public static Uri create(UriScheme scheme,
                         UriAuthority authority,
                         UriPath path)

create

public static Uri create(UriScheme scheme,
                         UriAuthority authority)

create

public static Uri create(UriPath path,
                         UriQuery query,
                         UriFragment fragment)

create

public static Uri create(UriPath path,
                         UriQuery query)

create

public static Uri create(UriPath path,
                         UriFragment fragment)

create

public static Uri create(UriPath path)

create

public static Uri create(UriPart part)

standardParser

public static UriParser standardParser()

parse

public static Uri parse(String string)

form

@Kind
public static swim.structure.Form<Uri> form()