maspack.fileutil.uri

Class URIx

java.lang.Object

maspack.fileutil.uri.URIx

public class URIx
extends java.lang.Object

Extended URI class that handles nested URIs required for zip files

Author:

antonio

Constructor Summary

Constructors

Constructor and Description
URIx() Creates empty relative URI
URIx(java.io.File file) Constructs a URI for a File object
URIx(java.lang.String uri) Constructs a URI based on a string version (percent-encoded)
URIx(java.lang.String scheme, java.lang.String host, java.lang.String path) Constructs a URI with given scheme, host, and path
URIx(java.lang.String scheme, java.lang.String userInfo, java.lang.String host, int port, java.lang.String path, java.lang.String query, java.lang.String fragment) Complete constructor, builds a URI providing all info
URIx(java.lang.String scheme, java.lang.String userInfo, java.lang.String host, java.lang.String path) Constructs a URI with given scheme, user info, host, and path
URIx(java.lang.String scheme, URIx nestedURI, java.lang.String fragment) Creates a nested URI, the scheme must be a zip-type (e.g.
URIx(URIx uri) Copies a URI
URIx(URIxScheme scheme, java.lang.String host, java.lang.String path) Constructs a URI with given scheme, host, and path

Method Summary

Modifier and Type	Method and Description
void	clear() Sets the URI to an empty relative URI
boolean	equals(java.lang.Object obj)
boolean	equals(URIx other) Checks equality of two URIs
java.lang.String	getAuthority() Returns the encoded authority string
URIx	getBaseURI() Returns the base URI for nested URIs, or the current URI if it is non-zip type
static URIx	getBaseURI(URIx uri) Determines the base URI, representing the lowest file or relative path in a set of nested URIs
java.lang.String	getFragment() Returns the encoded fragment
java.lang.String	getHost() Returns the encoded host
URIx	getNestedURI() If this is a zip-type URI, returns the nested URI
java.lang.String	getPassword() Returns the encoded password
java.lang.String	getPath() Returns the encoded path
int	getPort() Returns the port
java.lang.String	getQuery() Gets the encoded query string
java.lang.String	getRawFragment() Returns the raw fragment
java.lang.String	getRawHost() Returns the raw host
java.lang.String	getRawPassword() Returns the raw decoded password
java.lang.String	getRawPath() Returns the raw path
java.lang.String	getRawQuery() Gets the raw query string
java.lang.String	getRawUserName() Returns the decoded username
URIxScheme	getScheme() Returns the scheme of this URI
java.lang.String	getSchemeSpecificPart() Returns the encoded scheme-specific part
static java.lang.String	getSchemeStr(java.lang.String uri) Extracts the scheme string from a URI
java.util.ArrayList<URIx>	getURIStack() Returns a stack-representation of nested URIs with the base at the end of the stack
static java.util.ArrayList<URIx>	getURIStack(URIx uri) Creates a stack representation of a nested URI with the base at the end of the stack
java.lang.String	getUserInfo() Returns the encoded user info string
java.lang.String	getUserName() Returns the encoded username
boolean	isRelative() Checks if the URI is relative (i.e.
boolean	isSchemeSupported(java.lang.String scheme) Checks if the provided scheme is supported.
boolean	isZipType() Checks if the current URI is of zip-type, which allows for nested URIs.
static java.lang.String	percentDecode(java.lang.String str) Percent-decodes a string
static java.lang.String	percentEncode(java.lang.String str, java.lang.String reservedChars) Percent-encodes a string with a given set of reserved characters.
URIx	relativize(java.lang.String uri) Creates a URI relative to the current from the provided input.
URIx	relativize(URIx uri) Creates a URI relative to the current from the provided input.
static URIx	relativize(URIx base, URIx child) Creates a relative URI such that child = URIx.resolve(base, relative); Requires that child is hierarchically equivalent to base, except for difference in path (if not a zip-type) or fragment (if zip type).
URIx	resolve(java.lang.String rel) Resolves a relative URI string
URIx	resolve(URIx uri) Resolves a relative URI
static URIx	resolve(URIx base, java.io.File file) Resolves a URI provided a File.
static URIx	resolve(URIx base, java.lang.String rel) Resolves a URI provided a string representation of a URI
static URIx	resolve(URIx base, URIx relative) Merges two URIs
void	set(java.lang.String uri) Sets this URI to the encoded string representation
void	set(URIx uri) Sets this URI to the provided one
void	setAuthority(java.lang.String authority) Sets the encoded authority string
void	setBaseURI(URIx base) Sets the nested base URI to the provided one.
void	setFragment(java.lang.String fragment) Sets the encoded fragment
void	setHost(java.lang.String host) Sets the encoded host
void	setNestedURI(URIx nestedURI) Sets the nested URI for zip-type URIs
void	setPassword(java.lang.String password) Sets the encoded password, null to clear
void	setPath(java.lang.String path) Sets the encoded path
void	setPort(int port) Sets the port
void	setQuery(java.lang.String query) Sets the encoded query string
void	setRawFragment(java.lang.String fragment)
void	setRawHost(java.lang.String host) Sets the raw host
void	setRawPassword(java.lang.String password) Sets the raw password, null to clear
void	setRawPath(java.lang.String path) Sets the raw path
void	setRawQuery(java.lang.String query) Sets the raw query string
void	setRawUserName(java.lang.String userName) Sets the raw username
void	setScheme(java.lang.String scheme) Tries to set the scheme
void	setScheme(URIxScheme scheme) Sets the scheme
void	setSchemeSpecificPart(java.lang.String ssp) Sets the encoded scheme-specific part
void	setUserInfo(java.lang.String userInfo) Sets the encoded user info string
void	setUserName(java.lang.String userName) Sets the encoded username
java.lang.String	toString() Returns the full string representation of this encoded URI
java.net.URI	toURI() Converts to a java URI
java.net.URL	toURL()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

URIx

public URIx()

Creates empty relative URI

URIx

public URIx(URIx uri)

Copies a URI

Parameters:

uri - uri to copy

URIx

public URIx(java.lang.String uri)
     throws URIxSyntaxException

Constructs a URI based on a string version (percent-encoded)

Parameters:

uri - string to parse

Throws:

URIxSyntaxException - if the URI fails to parse

URIx

public URIx(java.io.File file)

Constructs a URI for a File object

Parameters:

file - URI file destination

URIx

public URIx(java.lang.String scheme,
            java.lang.String host,
            java.lang.String path)
     throws URIxSyntaxException

Constructs a URI with given scheme, host, and path

Parameters:

scheme - scheme string

host - encoded host string

path - encoded path string

Throws:

URIxSyntaxException

URIx

public URIx(URIxScheme scheme,
            java.lang.String host,
            java.lang.String path)

Constructs a URI with given scheme, host, and path

Parameters:

scheme - scheme type

host - encoded host string

path - encoded path string

Throws:

URIxSyntaxException - if the URI fails to parse

URIx

public URIx(java.lang.String scheme,
            java.lang.String userInfo,
            java.lang.String host,
            java.lang.String path)
     throws URIxSyntaxException

Constructs a URI with given scheme, user info, host, and path

Parameters:

scheme - scheme string

userInfo - encoded userInfo string, which can include username and password

host - encoded host string

path - encoded path string

Throws:

URIxSyntaxException - if the URI fails to parse

URIx

public URIx(java.lang.String scheme,
            URIx nestedURI,
            java.lang.String fragment)
     throws URIxSyntaxException

Creates a nested URI, the scheme must be a zip-type (e.g. zip, tar, jar, ...)

Parameters:

scheme - scheme string

nestedURI - nested URI to underlying zip resource

fragment - encoded fragment string

Throws:

URIxSyntaxException - if the URI fails to parse

URIx

public URIx(java.lang.String scheme,
            java.lang.String userInfo,
            java.lang.String host,
            int port,
            java.lang.String path,
            java.lang.String query,
            java.lang.String fragment)
     throws URIxSyntaxException

Complete constructor, builds a URI providing all info

Parameters:

scheme - scheme string

userInfo - encoded userinfo string

host - encoded host string

port - port

path - encoded path string

query - encoded query string

fragment - encoded fragment string

Throws:

URIxSyntaxException - if the URI fails to parse

Method Detail

set

public void set(URIx uri)

Sets this URI to the provided one

Parameters:

uri - URI to copy

clear

public void clear()

Sets the URI to an empty relative URI

isSchemeSupported

public boolean isSchemeSupported(java.lang.String scheme)

Checks if the provided scheme is supported. If it is not, it can be added using URIxScheme.createScheme(String, int, String[])

Parameters:

scheme - scheme string

Returns:

true if currently supported, false otherwise

getRawUserName

public java.lang.String getRawUserName()

Returns the decoded username

Returns:

username

getUserName

public java.lang.String getUserName()

Returns the encoded username

Returns:

username

setRawUserName

public void setRawUserName(java.lang.String userName)

Sets the raw username

Parameters:

userName - username

setUserName

public void setUserName(java.lang.String userName)

Sets the encoded username

Parameters:

userName - username

getRawPassword

public java.lang.String getRawPassword()

Returns the raw decoded password

Returns:

password

getPassword

public java.lang.String getPassword()

Returns the encoded password

Returns:

password

setRawPassword

public void setRawPassword(java.lang.String password)

Sets the raw password, null to clear

Parameters:

password - password

setPassword

public void setPassword(java.lang.String password)

Sets the encoded password, null to clear

Parameters:

password - password

getRawHost

public java.lang.String getRawHost()

Returns the raw host

Returns:

host

getHost

public java.lang.String getHost()

Returns the encoded host

Returns:

host

setRawHost

public void setRawHost(java.lang.String host)

Sets the raw host

Parameters:

host - host

setHost

public void setHost(java.lang.String host)

Sets the encoded host

Parameters:

host - host

getPort

public int getPort()

Returns the port

Returns:

port

setPort

public void setPort(int port)

Sets the port

Parameters:

port - port

getRawPath

public java.lang.String getRawPath()

Returns the raw path

Returns:

path

getPath

public java.lang.String getPath()

Returns the encoded path

Returns:

path

setRawPath

public void setRawPath(java.lang.String path)

Sets the raw path

Parameters:

path - path

setPath

public void setPath(java.lang.String path)

Sets the encoded path

Parameters:

path - path

getRawQuery

public java.lang.String getRawQuery()

Gets the raw query string

Returns:

query

getQuery

public java.lang.String getQuery()

Gets the encoded query string

Returns:

query

setRawQuery

public void setRawQuery(java.lang.String query)

Sets the raw query string

Parameters:

query - query

setQuery

public void setQuery(java.lang.String query)

Sets the encoded query string

Parameters:

query - query

getNestedURI

public URIx getNestedURI()

If this is a zip-type URI, returns the nested URI

Returns:

nested URI

setNestedURI

public void setNestedURI(URIx nestedURI)

Sets the nested URI for zip-type URIs

Parameters:

nestedURI - nexted URI

getRawFragment

public java.lang.String getRawFragment()

Returns the raw fragment

Returns:

fragment

getFragment

public java.lang.String getFragment()

Returns the encoded fragment

Returns:

fragment

setRawFragment

public void setRawFragment(java.lang.String fragment)

setFragment

public void setFragment(java.lang.String fragment)

Sets the encoded fragment

Parameters:

fragment - fragment

setScheme

public void setScheme(URIxScheme scheme)

Sets the scheme

Parameters:

scheme - scheme

setScheme

public void setScheme(java.lang.String scheme)
               throws URIxSyntaxException

Tries to set the scheme

Parameters:

scheme - scheme string

Throws:

URIxSyntaxException - if unknown scheme

getUserInfo

public java.lang.String getUserInfo()

Returns the encoded user info string

setUserInfo

public void setUserInfo(java.lang.String userInfo)

Sets the encoded user info string

Parameters:

userInfo - userInfo

getAuthority

public java.lang.String getAuthority()

Returns the encoded authority string

Returns:

authority

setAuthority

public void setAuthority(java.lang.String authority)

Sets the encoded authority string

Parameters:

authority - authority

getSchemeSpecificPart

public java.lang.String getSchemeSpecificPart()

Returns the encoded scheme-specific part

Returns:

scheme-specific part of URI

setSchemeSpecificPart

public void setSchemeSpecificPart(java.lang.String ssp)
                           throws URIxSyntaxException

Sets the encoded scheme-specific part

Parameters:

ssp - scheme-specific part

Throws:

URIxSyntaxException - if there is a parse error

percentEncode

public static java.lang.String percentEncode(java.lang.String str,
                                             java.lang.String reservedChars)

Percent-encodes a string with a given set of reserved characters.

Parameters:

str - string to encode

reservedChars - characters to encode

Returns:

encoded string

percentDecode

public static java.lang.String percentDecode(java.lang.String str)

Percent-decodes a string

Parameters:

str - string to decode

Returns:

decoded string

set

public void set(java.lang.String uri)
         throws URIxSyntaxException

Sets this URI to the encoded string representation

Parameters:

uri - URI string

Throws:

URIxSyntaxException - if there is a parse error

getSchemeStr

public static java.lang.String getSchemeStr(java.lang.String uri)

Extracts the scheme string from a URI

Parameters:

uri - URI string

getScheme

public URIxScheme getScheme()

Returns the scheme of this URI

Returns:

scheme

toString

public java.lang.String toString()

Returns the full string representation of this encoded URI

Overrides:

toString in class java.lang.Object

Returns:

URI string

setBaseURI

public void setBaseURI(URIx base)

Sets the nested base URI to the provided one. This can be used to change the source of a zip-type URI

Parameters:

base - new base URI

getBaseURI

public URIx getBaseURI()

Returns the base URI for nested URIs, or the current URI if it is non-zip type

Returns:

base URI

resolve

public URIx resolve(java.lang.String rel)

Resolves a relative URI string

Parameters:

rel - relative URI

Returns:

resolved URI

resolve

public URIx resolve(URIx uri)

Resolves a relative URI

Parameters:

uri - relative URI

Returns:

resolved URI

relativize

public URIx relativize(URIx uri)

Creates a URI relative to the current from the provided input. If no such relative URI exists, then a copy of the input is returned.

Parameters:

uri - URI to relativize relative to this URI

Returns:

relativized URI

relativize

public URIx relativize(java.lang.String uri)

Creates a URI relative to the current from the provided input. If no such relative URI exists, then a copy of the input is returned.

Parameters:

uri - URI to relativize relative to this URI

Returns:

relativized URI

getURIStack

public java.util.ArrayList<URIx> getURIStack()

Returns a stack-representation of nested URIs with the base at the end of the stack

getURIStack

public static java.util.ArrayList<URIx> getURIStack(URIx uri)

Creates a stack representation of a nested URI with the base at the end of the stack

Parameters:

uri - URI to extract

Returns:

URI stack

isRelative

public boolean isRelative()

Checks if the URI is relative (i.e. the base URI has no scheme)

resolve

public static URIx resolve(URIx base,
                           URIx relative)

Merges two URIs

Parameters:

base - URI base

relative - extension relative to base

Returns:

merged URI

resolve

public static URIx resolve(URIx base,
                           java.io.File file)

Resolves a URI provided a File. If the file object is absolute, replaces the path (or fragment for zip-types). Otherwise, resolves the relative path (or fragment).

Parameters:

base - base URI

file - file to resolves

Returns:

resolved URI

resolve

public static URIx resolve(URIx base,
                           java.lang.String rel)

Resolves a URI provided a string representation of a URI

Parameters:

base - base URI

rel - relative or absolute URI string

Returns:

resolved URI

relativize

public static URIx relativize(URIx base,
                              URIx child)

Creates a relative URI such that child = URIx.resolve(base, relative); Requires that child is hierarchically equivalent to base, except for difference in path (if not a zip-type) or fragment (if zip type). Otherwise, returns the child URI.

Parameters:

base - base URI

child - child URI

Returns:

relative URI between base and child

isZipType

public boolean isZipType()

Checks if the current URI is of zip-type, which allows for nested URIs. Zip-types are defined by the scheme properties.

Returns:

true if zip type

getBaseURI

public static URIx getBaseURI(URIx uri)

Determines the base URI, representing the lowest file or relative path in a set of nested URIs

Parameters:

uri - URI to determine base of

Returns:

base URI

toURI

public java.net.URI toURI()
                   throws java.net.URISyntaxException

Converts to a java URI

Returns:

URI

Throws:

java.net.URISyntaxException - if there is a parsing error

toURL

public java.net.URL toURL()
                   throws java.net.MalformedURLException,
                          java.net.URISyntaxException

Throws:

java.net.MalformedURLException

java.net.URISyntaxException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(URIx other)

Checks equality of two URIs

Parameters:

other - URI to compare to

Returns:

true if equal