io.mola.galimatias

Class URL

java.lang.Object

io.mola.galimatias.URL

All Implemented Interfaces:

Serializable

public class URL
extends Object
implements Serializable

A parsed URL. Immutable.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
String	authority()
static URL	buildFile() Gets a URL object for file:// scheme.
static URL	buildHierarchical(String scheme, String host) Gets a URL object from a relative scheme and a host.
static URL	buildOpaque(String scheme) Gets a URL object from a non-relative scheme.
int	defaultPort()
boolean	equals(Object obj)
String	file()
String	fragment()
static URL	fromJavaURI(URI uri) Construct a URL from a URI.
static URL	fromJavaURL(URL url) Construct a URL from a URL.
int	hashCode()
Host	host()
boolean	isHierarchical()
boolean	isOpaque()
static URL	parse(String input) Parses a URL by using the default parsing options.
static URL	parse(URLParsingSettings settings, String input)
static URL	parse(URLParsingSettings settings, URL base, String input)
static URL	parse(URL base, String input)
String	password()
String	path()
List<String>	pathSegments()
int	port()
String	query()
String	relativize(URL url) Returns a relative URL reference for the given URL.
URL	resolve(String input) Resolves a relative reference to an absolute URL.
String	scheme()
String	schemeData()
String	toHumanString() Serializes the URL to a human-readable representation.
URI	toJavaURI() Converts to URI.
URL	toJavaURL() Converts to URL.
String	toString() Serializes the URL.
String	userInfo() Gets user info component (i.e. user:pass).
String	username()
URL	withFragment(String fragment)
URL	withHost(Host host)
URL	withHost(String host)
URL	withPassword(String password)
URL	withPath(String path)
URL	withPort(int port)
URL	withQuery(String query)
URL	withScheme(String scheme)
URL	withUsername(String username)

Methods inherited from class java.lang.Object

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

Method Detail

scheme

public String scheme()

schemeData

public String schemeData()

username

public String username()

password

public String password()

userInfo

public String userInfo()

Gets user info component (i.e. user:pass). This will return an empty string if neither user or password are set.

Returns:

host

public Host host()

authority

public String authority()

port

public int port()

defaultPort

public int defaultPort()

path

public String path()

pathSegments

public List<String> pathSegments()

query

public String query()

fragment

public String fragment()

file

public String file()

isHierarchical

public boolean isHierarchical()

isOpaque

public boolean isOpaque()

resolve

public URL resolve(String input)
            throws GalimatiasParseException

Resolves a relative reference to an absolute URL. This is just a convenience method equivalent to:

 
  URL base = URL.parse("http://base.com");
  String relativeReference = "/foo/bar";
  URL absoluteURL = base.resolve(relativeReference);
 
 

Parameters:

input - Relative reference.

Returns:

Resolved absolute URL.

Throws:

GalimatiasParseException

relativize

public String relativize(URL url)

Returns a relative URL reference for the given URL. Behaves as @{link java.net.URI#relativize(URL)}.

Parameters:

url - Absolute URL.

Returns:

Relative reference.

parse

public static URL parse(String input)
                 throws GalimatiasParseException

Parses a URL by using the default parsing options.

Parameters:

input -

Returns:

Throws:

GalimatiasParseException

parse

public static URL parse(URL base,
        String input)
                 throws GalimatiasParseException

Throws:

GalimatiasParseException

parse

public static URL parse(URLParsingSettings settings,
        String input)
                 throws GalimatiasParseException

Throws:

GalimatiasParseException

parse

public static URL parse(URLParsingSettings settings,
        URL base,
        String input)
                 throws GalimatiasParseException

Throws:

GalimatiasParseException

buildHierarchical

public static URL buildHierarchical(String scheme,
                    String host)
                             throws GalimatiasParseException

Gets a URL object from a relative scheme and a host.

Parameters:

scheme -

host -

Returns:

Throws:

GalimatiasParseException

buildFile

public static URL buildFile()
                     throws GalimatiasParseException

Gets a URL object for file:// scheme.

Returns:

Throws:

GalimatiasParseException

buildOpaque

public static URL buildOpaque(String scheme)
                       throws GalimatiasParseException

Gets a URL object from a non-relative scheme.

Parameters:

scheme -

Returns:

Throws:

GalimatiasParseException

withScheme

public URL withScheme(String scheme)
               throws GalimatiasParseException

Throws:

GalimatiasParseException

withUsername

public URL withUsername(String username)
                 throws GalimatiasParseException

Throws:

GalimatiasParseException

withPassword

public URL withPassword(String password)
                 throws GalimatiasParseException

Throws:

GalimatiasParseException

withHost

public URL withHost(String host)
             throws GalimatiasParseException

Throws:

GalimatiasParseException

withHost

public URL withHost(Host host)
             throws GalimatiasParseException

Throws:

GalimatiasParseException

withPort

public URL withPort(int port)
             throws GalimatiasParseException

Throws:

GalimatiasParseException

withPath

public URL withPath(String path)
             throws GalimatiasParseException

Throws:

GalimatiasParseException

withQuery

public URL withQuery(String query)
              throws GalimatiasParseException

Throws:

GalimatiasParseException

withFragment

public URL withFragment(String fragment)
                 throws GalimatiasParseException

Throws:

GalimatiasParseException

toJavaURI

public URI toJavaURI()
              throws URISyntaxException

Converts to URI. Conversion to URI will throw URISyntaxException if the URL contains unescaped unsafe characters as defined in RFC 2396. In order to prevent this, force RFC 2396 compliance when parsing the URL. For example: NOTE 1: This will not make distinction between no user and password and just empty user and no password.

          
              URL.parse("http://example.com").toJavaURI().toString() -> "http://example.com"
              URL.parse("http://@example.com").toJavaURI().toString() -> "http://example.com"
          
      

TODO: Check if this exception can actually be thrown

Returns:

Throws:

URISyntaxException

toJavaURL

public URL toJavaURL()
              throws MalformedURLException

Converts to URL. This method is guaranteed to not throw an exception for URL protocols http, https, ftp, file and jar. It might or might not throw MalformedURLException for other URL protocols.

Returns:

Throws:

MalformedURLException

fromJavaURI

public static URL fromJavaURI(URI uri)

Construct a URL from a URI.

Parameters:

uri -

Returns:

fromJavaURL

public static URL fromJavaURL(URL url)

Construct a URL from a URL.

Parameters:

url -

Returns:

toString

public String toString()

Serializes the URL. Note that the "exclude fragment flag" (as in WHATWG standard) is not implemented.

Overrides:

toString in class Object

toHumanString

public String toHumanString()

Serializes the URL to a human-readable representation. That is, percent-decoded and with IDN domains in its Unicode representation.

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object